GraphQL API

Latest Poppulo platform GraphQL API

API Overview

Getting Started

Authorization

Pagination

Complexity Limiting

Rate Limiting

Sorting and Filtering

Updates and Deprecation

Operations

Communications

Create Post Comment

Create Reaction

Follow Employee Feed Group

Get Account Content Settings As Member

Get Employee Feed Group

Get Employee Feed Groups

Get Group Posts

Get My Content Settings

Get Post

Get Posts

Get Reaction

Get Unread Posts

Get Unseen Post Count

Reset Unseen Post Count

Unfollow Employee Feed Group

Update Post Comment

Update Reaction

User Management

Reporting

Get Data Extract

Trigger Data Extract

Other

Accept EULA Agreement

Adds a user to groups

Associate Account With Org

Authorize SPO/Teams feed reader app integration

Authorize a Sharepoint feed reader app integration

Authorize a TeamsFx feed reader app integration

Check email translation status

Configure AI Content Assist For Sub accounts

Configure Account Content Settings

Configure Account Reporting Settings

Configure Analytics Report Settings

Configure Enterprise Sub Account Settings

Configure Generative AI Settings

Configure Org Settings

Configure SPO/Teams feed reader app integration

Configure Sharepoint app integration

Configure TeamsFx app integration

Configure TeamsFx app integration Tenant app catalog app Id

Create OAuth Client

Create OAuth Client With Permissions

Create SPO/Teams feed reader app integration

Create Sharepoint feed reader app integration

Create TeamsFx feed reader app integration

Create a new feed group for a given enterprise ID and account ID

Create a user provisioned by API

Delete OAuth Client

Delete SPO/Teams feed reader app integration

Delete a Sharepoint Feed Reader app integration

Delete a TeamsFx Feed Reader app integration

Deletes a SCIM provisioned group

Deletes a user provisioned by SCIM

Deletes a user provisioned by SCIM from group

Edit SPO/Teams feed reader app integration details

Edit a Sharepoint integration details

Edit a TeamsFx integration details

EventHub GetEventById

EventHub createEvent

EventHub getEvents will list all events sorted by timestamp newest first.

EventHub getEventsByPrincipalAndResourceType retrieves EventHub events related to a specific principal and resourceType

EventHub getEventsByResourceTypeForAccount retrieves EventHub events related to a specific account and resourceType

EventHub getSeries retrieves EventHub events related to a specific Series ID

EventHub unsafeCreateEvent

Generate url for download (machine to machine only)

Get Account

Get Account Org Settings

Get Account Reporting Settings

Get All Accounts

Get All My Enterprise Accounts

Get All OAuth Clients

Get Cloud Enabled Accounts

Get EULA Agreement

Get EULA Agreement by UserId and CustomerId

Get Email and Feeds User by ID

Get Enterprise Content Settings

Get Enterprise Sub Account Settings for Account

Get Feed Groups For Devices By Poppulo Enterprise Id

Get Filtered Accounts

Get Generative Ai Settings for Account

Get My Email and Feeds Account Selection

Get My Email and Feeds Panel for Harmony Dashboard

Get My Harmony Dashboard

Get My Platform Overview Dashboard

Get OAuth Client

Get Org Settings

Get Product

Get Product Module

Get SPFx feed reader app integration documentation

Get SPFx/TeamsFx feed reader app integration documentation

Get SPO/Teams feed reader app integration

Get SPO/Teams feed reader app integration documentation

Get SPO/Teams feed reader app integrations

Get Saved Search Groups

Get Tag Groups

Get TeamsFx feed reader app integration documentation

Get Templates By Account

Get Unified Template

Get User Enterprise Account

Get User Group by ID

Get all feed reader app integrations

Get emails in a folder

Get feed groups

Get folders and emails for workflow

Get folders for an account

Get list of Analytics Reporting Settings for sub accounts for the current enterprise account

Get list of sub accounts where content assist is disabled.

Get the ACTIVE TeamsFx integration configured for the Azure tenant

Get the ACTIVE TeamsFx integration configured for the Azure tenant and enterprise id

Get the Dashboard Panel for Digital Signage

Get the Digital Signage Account Selection

Get the TeamsFx integration configured for the Azure tenant

Get the specified feed reader app integration

Get the specified integration definition

GetNotessaContentItemsForEnterpriseByContentIds

Internal Get Data Extract

Internal Trigger Data Extract

List Account roles

List Available CLient Permissions

List Email and Feeds User Groups

List Email and Feeds Users

People who opened mailing

Process Multiple Saved Search Group Subscribers

Process Subscribers By Email Addresses

Process Tag Group Subscribers

Publish microsite for email

Render email for workflow

Reserve Slot for Upload

Reserve slot for upload (machine to machine only)

Retrieve a list of integration definitions

Save template

Search Subscribers By Email

Select Email and Feeds Account

Set SPO/Teams feed reader app integration as downloaded

Set Sharepoint feed reader app integration as downloaded

Set TeamsFx feed reader app integration as downloaded

Update OAuth Client Metadata

Update OAuth Client Secret

Update Tenant

Update a user provisioned by SCIM

Update an existing group

createCustomer

createTenant

deleteCustomer

getAllCustomers

getAllPoppuloEnterprises

getCampaignsByLegacyAccountId

getCustomerByExternalTenantId

getCustomerByFwiCompanyId

getCustomerById

getCustomerByPoppuloEnterpriseId

getCustomerByPoppuloLegacyId

getCustomerBySalesforceId

getCustomerBySsgShardId

getCustomerBySsgShardKey

getCustomers

getCustomersByExternalTenantId

getCustomersByName

getFwiCustomers

getMyHarmonyAccounts

getPoppuloCustomers

getPoppuloEnterprise

getPoppuloEnterpriseById

getPoppuloEnterpriseByLegacyId

getSsgCustomers

getTenantByExternalTenantId

getTenantByFwiCompanyId

getTenantById

getTenantByPoppuloEnterpriseId

getTenantByPoppuloLegacyId

getTenantBySsgShardKey

mergeCustomers

updateCustomer

updateCustomerFwiCompanyMapping

updateCustomerPoppuloEnterprise

updateCustomerSsgCustomer

updateTenantFwiCompanyMapping

updateTenantPoppuloEnterprise

updateTenantSsgCustomer

Types

Directives

Auth

Deprecated

Has Account Permissions

Has Enterprise Permissions

Has Harmony Permissions

Inaccessible

Include

Inject Accounts With Permissions

One Of

Skip

Specified By

Tag

Enums

Account Classification

Account Type

Analytics Configure Reporting Settings Status

Analytics Data Extract Status

Analytics Internal Data Extract Status

Analytics Report Visibility

Article Category

Cache Control Scope

Campaigns Status Value

Claim Check Validation Error Code Enum

Employee Feed Group Connection Sort Field

Event Hub Event Connection Sort Field

Feed Group Audience Type

Feed Group Device View Connection Sort Field

Feed Group Posts Device View Connection Sort Field

Feed Group Sort Field

Feed Group Subscription Status

Feed Group Target Channel

Feed Reader App Integration Connection Sort Field

Integration Type

Notessa Content Email Text Format

Notessa Content Folder Type

Notessa Content Translation Job Status

Notessa Content Update Translation Job Status

Notessa User Management Filter Operator

Notessa User Management List Email And Feeds User Groups Sort Field

Notessa User Management List Email And Feeds Users Sort Field

Notessa User Management Logical Operator

Notessa User Management Validation Error Code Enum

Platform Poppulo Enterprise Connection Sort Sort Field

PlatformCustomerSortField

PlatformPrimaryAuthentication

Post Type

Reaction Type

SPOTeams Feed Reader App Integration Connection Sort Field

SPOTeams Feed Reader App Integration User Token Mapping

Sort Order

Status

Unified Template Page Type

Unified Template Sort Field

Unified Template Template Status

Input Objects

Account Organisation Association Input

Analytics Configure Reporting Settings Input

Analytics Get Data Extract Input

Analytics Internal Get Data Extract Input

Analytics Internal Trigger Data Extract Input

Analytics Reporting Settings Filter Input

Analytics Trigger Data Extract Input

Campaigns Get Campaigns By Legacy Account Id Input

Claim Check Reserve Slot For Upload Input

Claim Check Unsafe Generate Url For Download Input

Claim Check Unsafe Reserve Slot For Upload Input

Configure Ai Content Assist For Sub Accounts Input

Configure Enterprise Sub Account Settings Input

Configure Generative Ai Settings Input

Content Settings Input

Create Feed Group In Account Input

CreateCustomerInput

CreateTenantInput

DigitalSignageTenant

Edit App Integration Input

EmailAndFeedsTenant

Employee Feed Group Connection Sort

Eula Agreement Audit Details Input

Event Hub Create Event Input

Event Hub Event Connection Sort

Event Hub Get Event By Id Input

Event Hub Get Events By Principal And Resource Type Input

Event Hub Get Events By Resource Type For Account Input

Event Hub Get Events Input

Event Hub Get Series Input

Event Hub Unsafe Create Event Input

Feed Group Connection Sort

Feed Group Device View Connection Sort

Feed Group Posts Device View Connection Sort

Feed Reader App Integration Connection Sort

MergeCustomersInput

Notessa Content Add People To Mailing Record Input

Notessa Content Cancel Translation Job For Email Input

Notessa Content Check Translation Job For Email Status Input

Notessa Content Create Translation Job For Email Input

Notessa Content Create Workflow Mailing Record Input

Notessa Content Get Emails In Folder Input

Notessa Content Get Folders And Emails Input

Notessa Content Get Folders Input

Notessa Content Get Notessa Content Items For Enterprise By Content Ids Input

Notessa Content Item Input

Notessa Content Item With Base64Encoded Content Input

Notessa Content Publish Microsite For Email Input

Notessa Content Render Email Input

Notessa Content Unsafe Get Emails Of People Who Read Mailing Input

Notessa Content Update Translations For Notessa Content Ids And Job Id With Base64Encoded Content Input

Notessa Content Update Translations For Notessa Content Ids Input

Notessa Content Update Translations For Notessa Content Ids With Base64Encoded Content Input

Notessa Content Workflow Mailing Record Details

Notessa Content Workflow Mailing Record Sender Details

Notessa User Management Add Email And Feeds User To Groups Input

Notessa User Management Create Email And Feeds User Group Input

Notessa User Management Create Email And Feeds User Input

Notessa User Management Delete Email And Feeds User From Group Input

Notessa User Management Delete Email And Feeds User Group Input

Notessa User Management Delete Email And Feeds User Input

Notessa User Management Filter Expression Input

Notessa User Management Get User Group Input

Notessa User Management Get User Input

Notessa User Management List Email And Feeds User Groups Input

Notessa User Management List Email And Feeds User Groups Sorting Input

Notessa User Management List Email And Feeds Users Input

Notessa User Management List Email And Feeds Users Sorting Input

Notessa User Management Overwrite Email And Feeds User Group Input

Notessa User Management Update Email And Feeds User Group Input

Notessa User Management Update User Input

OAuth Client Permission Input

OAuth Create Client Input

OAuth Create Client With Permissions Input

OAuth Delete Client Input

OAuth Get Client Input

OAuth Update Client Metadata Input

OAuth Update Client Secret Input

Org Filter Input

Org Level Cloud Flags Input

Pagination Options

Platform Poppulo Enterprise Connection Sort

PlatformCustomerSortBy

Product Get Poppulo Product Input

Product Get Poppulo Product Module Input

Reporting Settings Input

SPOTeams Configure App Integration Input

SPOTeams Edit App Integration Input

SPOTeams Feed Reader App Integration Configuration

SPOTeams Feed Reader App Integration Connection Sort

Subscriber Get Saved Searches Input

Subscriber Get Subscribers By Email Input

Subscriber Get Tags Input

Subscriber Input

Subscriber Process Subscribers By Email Input

Subscriber Process Subscribers By Saved Searches Input

Subscriber Process Subscribers By Tags Input

Unified Template Filter Input

Unified Template Get Template By Id Input

Unified Template Get Templates By Account Input

Unified Template Page Input

Unified Template Pagination Options Input

Unified Template Save Template Input

Unified Template Sort Input

Update Feed Group In Account Input

Update Tenant Input

UpdateCustomerFwiCompanyInput

UpdateCustomerInput

UpdateCustomerPoppuloEnterpriseInput

UpdateCustomerSsgCustomerInput

UpdateTenantFwiCompanyInput

UpdateTenantPoppuloEnterpriseInput

UpdateTenantSsgCustomerInput

WorkplaceTenant

Interfaces

Connection

Edge

Error

Feed Reader App Integration

Node

SubTenant

Objects

Accept Eula Agreement Payload

Account

Account Org Settings Connection

Account Org Settings Edge

Account Organisation Association

Accounts Error

Accounts Get Poppulo Enterprise Success

Accounts Poppulo Enterprise Not Found Error

Analytics Configure Reporting Settings Payload

Analytics Get Data Extract Error

Analytics Get Data Extract Success

Analytics Internal Get Data Extract Error

Analytics Internal Get Data Extract Success

Analytics Internal Trigger Data Extract Error

Analytics Internal Trigger Data Extract Success

Analytics Job Not Found Error

Analytics Reporting Settings

Analytics Reporting Settings Connection

Analytics Reporting Settings Edge

Analytics Trigger Data Extract Error

Analytics Trigger Data Extract Success

Attachment

Campaigns Campaign

Campaigns Error

Campaigns Get Campaigns By Legacy Account Id Success

Campaigns Status

Claim Check Error

Claim Check Reserve Slot For Upload Success

Claim Check Unsafe Generate Url For Download Success

Claim Check Unsafe Reserve Slot For Upload Success

Claim Check Validation Error

Comment

Comment Component

Comments

Components

Configure Ai Content Assist For Sub Accounts Payload

Configure Enterprise Sub Account Settings Payload

Configure Generative Ai Settings Payload

Content Settings

Content Settings For Account As Member Response

Content Settings Response

Create Customer Payload

Customer

CustomerTenantConnection Connection

Delete Customer Payload

Delete Tenant Payload

Digital Signage Account

Digital Signage Account Selection

DigitalSignageTenant

Email And Feeds Account Selection

EmailAndFeedsTenant

Employee Feed Group

Employee Feed Group Connection

Employee Feed Group Edge

Enterprise Sub Account Settings

Eula Agreement Payload

Event Hub Create Event Success

Event Hub Error

Event Hub Event

Event Hub Event Creation Failed Error

Event Hub Event Not Found Error

Event Hub Event Series Connection

Event Hub Event Series Edge

Event Hub Event Series Not Found Error

Event Hub Events Connection

Event Hub Events Not Found Error

Event Hub Get Event By Id Success

Event Hub Get Events By Principal And Resource Type Success

Event Hub Get Events By Resource Type For Account Success

Event Hub Get Events Success

Event Hub Get Series Success

Event Hub Unsafe Create Event Success

FWI Company

Feed Group

Feed Group Connection

Feed Group Device View

Feed Group Edge

Feed Groups In Enterprise For Devices

Feed Reader App Integration Documentation

Feed Reader App Integration Enterprise Connection

Feed Reader App Integration Enterprise Edge

Feed Reader App Integration State

Feed Response

Feed Response Connection

Feed Response Edge

Generative Ai Settings

Generative Ai Sub Account Settings

Get Content Settings For Poppulo Enterprise Payload

Get Enterprise Sub Account Settings Payload

Get Feed Groups For Device By Poppulo Enterprise Id

Get Generative Ai Settings For Sub Account With Enterprise Payload

Get Generative Ai Settings Payload

Get Generative Ai Sub Account Settings Payload

Get Sub Accounts Where Ai Content Assist Is Disabled Payload

Harmony Account

Harmony Dashboard

Harmony Dashboard Group

Harmony Dashboard Menu Item

Harmony Dashboard Panel

HarmonyTenant

Image

Integration Definition

Integration Definition Not Found

Integration Product Connection

Integration Product Edge

Landing Page Active Account Configuration Facts

Link

Merge Customers Payload

My Harmony Accounts Payload

Notessa Content Add People To Mailing Record Success

Notessa Content Create Workflow Mailing Record Success

Notessa Content Email Translation Job Not Found Error

Notessa Content Email Translation Job Status Error

Notessa Content Email Translation Job Status Success

Notessa Content Error

Notessa Content Get Emails In Folder Error

Notessa Content Get Emails In Folder Success

Notessa Content Get Folders And Emails Error

Notessa Content Get Folders And Emails Success

Notessa Content Get Folders Error

Notessa Content Get Folders Success

Notessa Content Get Notessa Content Items For Enterprise By Content Ids Payload

Notessa Content Item

Notessa Content Message

Notessa Content Publish Microsite For Email Success

Notessa Content Render Email Success

Notessa Content Translation Progress

Notessa Content Unsafe Get Emails Of People Who Read Mailing Success

Notessa Content Update Translations For Notessa Content Ids And Job Id With Base64Encoded Content Payload

Notessa Content Update Translations For Notessa Content Ids Payload

Notessa Content Update Translations For Notessa Content Ids With Base64Encoded Content Payload

Notessa Content Workflow Email

Notessa Content Workflow Folder

Notessa Content Workflow Folder Details

Notessa User Management Account Role

Notessa User Management Account Role Privilege

Notessa User Management Add Email And Feeds User To Groups Success

Notessa User Management Create Email And Feeds User Group Success

Notessa User Management Create Email And Feeds User Success

Notessa User Management Delete Email And Feeds User From Group Success

Notessa User Management Delete Email And Feeds User Group Success

Notessa User Management Delete Email And Feeds User Success

Notessa User Management Email And Feeds User

Notessa User Management Email And Feeds User Group

Notessa User Management Error

Notessa User Management Get User Success

Notessa User Management List Account Roles Success

Notessa User Management List Email And Feeds User Groups Success

Notessa User Management List Email And Feeds Users Success

Notessa User Management Overwrite Email And Feeds User Group Success

Notessa User Management Update Email And Feeds User Group Success

Notessa User Management Update User Success

Notessa User Management User Group Not Found Error

Notessa User Management User Not Found Error

Notessa User Management Validation Error

OAuth Client

OAuth Client Not Found Error

OAuth Client Permission

OAuth Create Client Success

OAuth Create Client With Permissions Success

OAuth Delete Client Success

OAuth Error

OAuth Get All Clients Success

OAuth Get Client Success

OAuth List Available Client Permissions Success

OAuth Update Client Metadata Success

OAuth Update Client Secret Success

OAuth Validation Error

Org Settings

Page Info

Platform Integration Edge

Platform Integrations Connection

Platform Overview Dashboard

Platform Overview Dashboard Group

Platform Overview Dashboard Menu Item

Platform Overview Dashboard Panel

Platform Poppulo Enterprise Connection

Platform Poppulo Enterprise Edge

PlatformCustomerConnection Relay Connection

PlatformCustomerEdge Relay Edge

Poppulo Enterprise

Poppulo Enterprise Feed Group Device View Connection

Poppulo Product

Poppulo Product Module

Post

Post Comment Edge

Post Comments Connection

Post Device View Connection

Post Device View Edge

Product Get Poppulo Product Module Success

Product Get Poppulo Product Success

Product Poppulo Product Module Not Found

Product Poppulo Product Not Found

Reaction

Reactions

Reading Time

Reporting Settings

SPOFeed Reader App Integration

SPOTeams Feed Reader App Integration

SPOTeams Feed Reader App Integration Documentation

SPOTeams Feed Reader App Integration Enterprise Connection

SPOTeams Feed Reader App Integration Enterprise Edge

SPOTeams Feed Reader App Integration State

SSG Customer

Subscriber

Subscriber Error

Subscriber Get Saved Searches Success

Subscriber Get Subscribers By Email Success

Subscriber Get Tags Success

Subscriber Group

Subscriber Process Subscribers By Email Success

Subscriber Process Subscribers By Saved Searches Success

Subscriber Process Subscribers By Tags Success

Teams Fx Feed Reader App Integration

Teams Fx Feed Reader App Integration Not Found

Tenant Payload

Unified Template Error

Unified Template Get Template By Id Success

Unified Template Get Templates By Account Success

Unified Template Page

Unified Template Page Metadata

Unified Template Save Template Success

Unified Template Template

Unified Template Template Metadata

Unified Template Template Not Found Error

Unread

Unread Response

Update Customer Payload

User

User Identity

Video

WorkplaceTenant

Scalars

Big Int

Boolean

Email Address

Epoch Millis

Int

Locale

Long

MDX

Poppulo Product Feature

String

Timezone

URL

Unions

Accounts Get Poppulo Enterprise Payload

Analytics Get Data Extract Payload

Analytics Internal Get Data Extract Payload

Analytics Internal Trigger Data Extract Payload

Analytics Trigger Data Extract Payload

Campaigns Get Campaigns By Legacy Account Id Payload

Claim Check Reserve Slot For Upload Payload

Claim Check Unsafe Generate Url For Download Payload

Claim Check Unsafe Reserve Slot For Upload Payload

Event Hub Create Event Payload

Event Hub Get Event By Id Payload

Event Hub Get Events By Principal And Resource Type Payload

Event Hub Get Events By Resource Type For Account Payload

Event Hub Get Events Payload

Event Hub Get Series Payload

Event Hub Unsafe Create Event Payload

Get Integration Definition

Notessa Content Add People To Mailing Record Payload

Notessa Content Cancel Translation Job For Email Payload

Notessa Content Check Translation Job For Email Status Payload

Notessa Content Create Translation Job For Email Payload

Notessa Content Create Workflow Mailing Record Payload

Notessa Content Get Emails In Folder Payload

Notessa Content Get Folders And Emails Payload

Notessa Content Get Folders Payload

Notessa Content Publish Microsite For Email Payload

Notessa Content Render Email Payload

Notessa Content Render Message Result

Notessa Content Unsafe Get Emails Of People Who Read Mailing Payload

Notessa User Management Add Email And Feeds User To Groups Payload

Notessa User Management Create Email And Feeds User Group Payload

Notessa User Management Create Email And Feeds User Payload

Notessa User Management Delete Email And Feeds User From Group Payload

Notessa User Management Delete Email And Feeds User Group Payload

Notessa User Management Delete Email And Feeds User Payload

Notessa User Management Email And Feeds User Group Payload

Notessa User Management Get User Response Payload

Notessa User Management List Account Roles Payload

Notessa User Management List Email And Feeds User Groups Payload

Notessa User Management List Email And Feeds Users Payload

Notessa User Management Overwrite Email And Feeds User Group Payload

Notessa User Management Update Email And Feeds User Group Payload

Notessa User Management Update User Response Payload

OAuth Create Client Payload

OAuth Create Client With Permissions Payload

OAuth Delete Client Payload

OAuth Get All Clients Payload

OAuth Get Client Payload

OAuth List Available Client Permissions Payload

OAuth Update Client Metadata Payload

OAuth Update Client Secret Payload

Product Get Poppulo Product Module Payload

Product Get Poppulo Product Payload

Return Type for TeamsFxFeedReaderAppIntegrationMutations -> configureTenantAppCatalogAppId

Subscriber Get Saved Searches Payload

Subscriber Get Subscribers By Email Payload

Subscriber Get Tags Payload

Subscriber Process Subscribers By Email Payload

Subscriber Process Subscribers By Saved Searches Payload

Subscriber Process Subscribers By Tags Payload

Teams Fx Feed Reader App Integration By Azure Tenant Id Payload

Unified Template Get Template By Id Payload

Unified Template Get Templates By Account Payload

Unified Template Save Template Payload

EventHubGetEventByIdPayload

EventHub Event Payload

Possible Types

EventHubGetEventByIdSuccess
EventHubGetEventByIdSuccess
EventHubEventNotFoundError
EventHubEventNotFoundError
EventHubError
EventHubError

Solutions

Communications
Reporting & insights

Poppulo APIs

GraphQL API
REST API

GraphQL API

EventHubGetEventByIdPayload

Possible Types

EventHubGetEventByIdSuccess

EventHubEventNotFoundError

EventHubError