Open API Reference
Welcome
Endpoint
https://open.api.woztell.com/v3
Open API is built around GraphQL.
Open API is built around GraphQL. It is recommended to have prior knowledge of GraphQL in order to make use of the Open API.
You can visit our Open API Playground, where you can test our Open API. For your reference, API Documentation and Schema are also available at the right side of the playground.
Authentication
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>
-
Follow this guide to generate an access token from your WOZTELL app.
-
In the Open API playground, insert the access token into the HTTP HEADERS.
How to test our API calls?
- Write your query on the left panel. You can try with the following call to get conversation history.
query getChatHistory (: IntMax100) {
apiViewer {
conversationHistory (first: ) {
edges {
node {
messageEvent
}
}
}
}
}
- You can refer to the SCHEMA and DOCS for other query types.
- Varaiables can be entered in the QUERY VARIABLES.
- Click the button to test the API call, the response will be displayed on the right panel.
Rate Limit
There are rate limits on our API calls. After sending an API call to WOZTELL with GraphQL Client (e.g. Postman), you can view the rate limit in Response Headers:
X-RateLimit-Remaining: The count of API calls that you can send in a minute
X-RateLimit-Limit: The count of API calls sent in a minute
Retry-After: The time needed until the next call after reaching the rate limit (in seconds)
Queries
apiViewer
Example
Query
query ApiViewer($appId: ID) {
apiViewer(appId: $appId) {
_id
actions {
edges {
...ActionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
activeMemberCounter {
data {
...ActiveMemberCounterFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_comment_member
total_no_of_member
}
admins {
edges {
...AdminEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
analyticsCustomEventOverviewDateHistogram {
edges {
...AnalyticsCustomEventCounterEdgeTBFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_analytics
}
analyticsCustomEventOverviewTable {
edges {
...AnalyticsCustomEventCounterEdgeRDFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_analytics
}
app {
_id
activated
createdAt
dataSource {
...DataSourceFragment
}
dataSources {
...DataSourceFragment
}
description
etag
id
inlets {
...ChannelFragment
}
integrations
managedBy {
...PartnerFragment
}
managementType
meta
name
outlets {
...ChannelFragment
}
pairs {
...PairFragment
}
teamMembers {
...TeamMemberFragment
}
updatedAt
}
assignment {
_id
active
adminContactMessage
app {
...AppFragment
}
appId
assignedAt
assignee {
...AdminFragment
}
assigner {
...AdminFragment
}
createdAt
etag
expiry
group {
...GroupFragment
}
groupExternalId
groupId
groupInfo
history
id
inactivatedAt
inlet {
...ChannelFragment
}
inletGroup
inletGroupExternalId
inletGroupInfo
inletId
inletMessage
isZendesk
label
member {
...MemberFragment
}
memberId
meta
noGroupCreation
parentAssignment {
...AssignmentFragment
}
parentAssignmentId
previousAssignment {
...AssignmentFragment
}
previousAssignmentId
reassign
reassignRelayMessage
redirectMemberToNode {
...RedirectFragment
}
relayMessage
status
tags
takenMessage
targets {
...AssignmentTargetFragment
}
updatedAt
}
assignments {
edges {
...AssignmentEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
audiences {
edges {
...AudienceEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
backgroundTask {
_id
app {
...AppFragment
}
appId
createdAt
data
endAt
etag
id
message
meta
runAt
status
type
updatedAt
}
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
channels {
edges {
...ChannelEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
chat {
_id
admin {
...AdminFragment
}
app {
...AppFragment
}
appId
assignment {
...AssignmentFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
deletedAt
deliveredAt
errors
etag
failedAt
from
group {
...GroupFragment
}
id
isMultipleParty
member {
...MemberFragment
}
memberId
messageEvent
meta
platform
readAt
sentAt
tags
updatedAt
}
conditions {
edges {
...ConditionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
conversationHistory {
edges {
...ChatEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
dailyActiveMemberOverview {
data {
...DailyActiveMemberRowFragment
}
pageInfo {
...PageInfoFragment
}
}
distinctDataSourceData
fetchDataSourceData
fetchGeoNearDataSourceData
file {
fileId
fileType
fileTypeV2 {
...FileTypeFragment
}
size
transcoded
transcodingError {
...GenericErrorFragment
}
url
}
files {
edges {
...FileEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
groups {
edges {
...GroupEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
installedIntegration {
_id
alias
app {
...AppFragment
}
appId
author {
...AuthorFragment
}
authorId
build
builderSidebarView {
...IntegrationViewFragment
}
changelog
channel {
...ChannelFragment
}
createdAt
customView {
...IntegrationViewFragment
}
dashboardView {
...IntegrationViewFragment
}
defaultResourceTemplate {
...ResourceTemplateFragment
}
description
endpoints {
...IntegrationEndpointsFragment
}
etag
features
functionString
hooks {
...HookFragment
}
icon
id
inbox {
...InboxIntegrationFragment
}
integrationDescription
integrationId
integrationKey
integrationName
integration_id
isLatestPublished
latestPublished
meta
platformSettingsView
privacyPolicyUrl
readme
resourceTemplates {
...ResourceTemplateFragment
}
scopes
secret
settingsSchema
settingsValidatorFunctionString
settingsView
signature
supportEmail
supportTicketing
supportedMediaTypes {
...SupportedMediaTypesFragment
}
termsAndConditionsUrl
trees {
...IntegrationTreeFragment
}
updatedAt
version
websiteUrl
}
installedIntegrations {
_id
alias
app {
...AppFragment
}
appId
author {
...AuthorFragment
}
authorId
build
builderSidebarView {
...IntegrationViewFragment
}
changelog
channel {
...ChannelFragment
}
createdAt
customView {
...IntegrationViewFragment
}
dashboardView {
...IntegrationViewFragment
}
defaultResourceTemplate {
...ResourceTemplateFragment
}
description
endpoints {
...IntegrationEndpointsFragment
}
etag
features
functionString
hooks {
...HookFragment
}
icon
id
inbox {
...InboxIntegrationFragment
}
integrationDescription
integrationId
integrationKey
integrationName
integration_id
isLatestPublished
latestPublished
meta
platformSettingsView
privacyPolicyUrl
readme
resourceTemplates {
...ResourceTemplateFragment
}
scopes
secret
settingsSchema
settingsValidatorFunctionString
settingsView
signature
supportEmail
supportTicketing
supportedMediaTypes {
...SupportedMediaTypesFragment
}
termsAndConditionsUrl
trees {
...IntegrationTreeFragment
}
updatedAt
version
websiteUrl
}
integrations
localeGroups {
edges {
...LocaleGroupEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
memberRaw
members {
edges {
...MemberEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
newMemberCounter {
data {
...NewMemberCounterFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_comment_member
total_no_of_member
}
nlpAnalyticsOverview {
edges {
...NLPAnalyticsCounterEdgeFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_nlp_analytics
}
nodes {
edges {
...NodeObjectEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
postCommentAnalyticsOverview {
edges {
...PostCommentAnalyticsOverviewEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
priorityGroups {
edges {
...PriorityGroupEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
responses {
edges {
...ResponseEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
subscriptionPushes {
edges {
...SubscriptionPushEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
ticket {
_id
active
app {
...AppFragment
}
appId
assignedAt
assignee {
...MemberFragment
}
assigneeId
createdAt
etag
externalId
history
id
inactivatedAt
inlet {
...ChannelFragment
}
inletId
label
masterTicketId
member {
...MemberFragment
}
memberId
meta
outlet {
...ChannelFragment
}
outletId
parentTicket {
...TicketFragment
}
parentTicketId
previousTicket {
...TicketFragment
}
previousTicketId
reassign
status
updatedAt
}
tickets {
data {
...TicketFragment
}
pageInfo {
...PageInfoFragment
}
}
tree {
_id
ancestorTree {
...TreeFragment
}
app {
...AppFragment
}
appId
configMap
configMapSchema
createdAt
description
etag
globalNodeIds
globalNodes {
...NodeObjectFragment
}
id
locked
name
nodeIds
nodes {
...NodeObjectFragment
}
siblingTrees {
...TreeFragment
}
stash {
...NodeObjectFragment
}
system
tags
templateTree {
...TreeFragment
}
templateTreeId
type
updatedAt
version
versionAlias
workspace {
...WorkspaceFragment
}
}
trees {
edges {
...TreeEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
triggers {
edges {
...TriggerEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
userContext
whatsAppFile {
err
err_code
ok
url
}
whatsAppTemplate {
edges {
...WhatsAppMessageTemplateEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
}
Variables
{"appId": 4}
Response
{
"data": {
"apiViewer": {
"_id": "4",
"actions": ActionConnection,
"activeMemberCounter": ActiveMemberCounterConnection,
"admins": AdminConnection,
"analyticsCustomEventOverviewDateHistogram": AnalyticsCustomEventCounterConnectionTB,
"analyticsCustomEventOverviewTable": AnalyticsCustomEventCounterConnectionRD,
"app": App,
"assignment": Assignment,
"assignments": AssignmentConnection,
"audiences": AudienceConnection,
"backgroundTask": BackgroundTask,
"channel": Channel,
"channels": ChannelConnection,
"chat": Chat,
"conditions": ConditionConnection,
"conversationHistory": ChatConnection,
"dailyActiveMemberOverview": DailyActiveMemberOverviewPayload,
"distinctDataSourceData": {},
"fetchDataSourceData": {},
"fetchGeoNearDataSourceData": {},
"file": RetrieveFilePayload,
"files": FileConnection,
"groups": GroupConnection,
"id": 4,
"installedIntegration": AppIntegration,
"installedIntegrations": [AppIntegration],
"integrations": {},
"localeGroups": LocaleGroupConnection,
"member": Member,
"memberRaw": {},
"members": MemberConnection,
"newMemberCounter": NewMemberCounterConnection,
"nlpAnalyticsOverview": NLPAnalyticsCounterConnection,
"nodes": NodeObjectConnection,
"postCommentAnalyticsOverview": PostCommentAnalyticsOverviewConnection,
"priorityGroups": PriorityGroupConnection,
"responses": ResponseConnection,
"subscriptionPushes": SubscriptionPushConnection,
"ticket": Ticket,
"tickets": TicketDataConnection,
"tree": Tree,
"trees": TreeConnection,
"triggers": TriggerConnection,
"userContext": {},
"whatsAppFile": WhatsAppFileUrl,
"whatsAppTemplate": WhatsAppMessageTemplateConnection
}
}
}
user
Response
Returns a User
Example
Query
query User {
user {
_id
acls
apps {
acls
app {
...AppFragment
}
appId
default
roles {
...RoleFragment
}
}
createdAt
email {
email
emails {
...EmailFragment
}
verified
}
etag
firstName
fullName
id
lastName
meta
ownRoles {
_id
acls
app {
...AppFragment
}
createdAt
etag
id
name
system
tags
updatedAt
}
partners {
acls
default
partner {
...PartnerFragment
}
partnerId
roles {
...RoleFragment
}
}
platformCred {
fbUserId
}
preferences {
recentTreeIds
recentTrees {
...TreeFragment
}
}
profilePic
sessionMeta
stripeProducts
tags
updatedAt
}
}
Response
{
"data": {
"user": {
"_id": "4",
"acls": ["abc123"],
"apps": [UserAppConfig],
"createdAt": {},
"email": EmailCred,
"etag": 4,
"firstName": "abc123",
"fullName": "xyz789",
"id": "4",
"lastName": "abc123",
"meta": {},
"ownRoles": [Role],
"partners": [UserPartnerConfig],
"platformCred": PlatformCred,
"preferences": UserPreferences,
"profilePic": "xyz789",
"sessionMeta": {},
"stripeProducts": {},
"tags": ["abc123"],
"updatedAt": {}
}
}
}
Mutations
Agenda
createAgenda
Description
A function to create agenda.\n
scope
["api:admin", "agenda:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateAgendaPayload
Arguments
| Name | Description |
|---|---|
input - CreateAgendaInput! |
Example
Query
mutation CreateAgenda($input: CreateAgendaInput!) {
createAgenda(input: $input) {
agenda {
_id
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
completed
createdAt
etag
id
lastRunAt
member {
...MemberFragment
}
memberId
meta
nextRunAt
node {
...NodeObjectFragment
}
nodeCompositeId
pattern
priority
responses
runUntil
subscriptionPush {
...AgendaSubscriptionPushConfigFragment
}
tag
tree {
...TreeFragment
}
treeId
type
updatedAt
}
agendaRaw
clientMutationId
}
}
Variables
{"input": CreateAgendaInput}
Response
{
"data": {
"createAgenda": {
"agenda": Agenda,
"agendaRaw": {},
"clientMutationId": 4
}
}
}
deleteAgenda
Description
A function to delete agenda.\n
scope
["api:admin", "agenda:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteAgendaPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAgendaInput! |
Example
Query
mutation DeleteAgenda($input: DeleteAgendaInput!) {
deleteAgenda(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteAgendaInput}
Response
{
"data": {
"deleteAgenda": {
"clientMutationId": "4"
}
}
}
updateAgenda
Description
A function to update agenda.\n
scope
["api:admin", "agenda:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateAgendaPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAgendaInput! |
Example
Query
mutation UpdateAgenda($input: UpdateAgendaInput!) {
updateAgenda(input: $input) {
agenda {
_id
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
completed
createdAt
etag
id
lastRunAt
member {
...MemberFragment
}
memberId
meta
nextRunAt
node {
...NodeObjectFragment
}
nodeCompositeId
pattern
priority
responses
runUntil
subscriptionPush {
...AgendaSubscriptionPushConfigFragment
}
tag
tree {
...TreeFragment
}
treeId
type
updatedAt
}
clientMutationId
}
}
Variables
{"input": UpdateAgendaInput}
Response
{
"data": {
"updateAgenda": {
"agenda": Agenda,
"clientMutationId": 4
}
}
}
App Integration
putAppIntegration
No longer supported
Description
A function to put app integration.\n Currently deprecated.\n
scope
["api:admin", "integration:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a PutAppIntegrationPayload
Arguments
| Name | Description |
|---|---|
input - PutAppIntegrationInput! |
Example
Query
mutation PutAppIntegration($input: PutAppIntegrationInput!) {
putAppIntegration(input: $input) {
app {
_id
activated
createdAt
dataSource {
...DataSourceFragment
}
dataSources {
...DataSourceFragment
}
description
etag
id
inlets {
...ChannelFragment
}
integrations
managedBy {
...PartnerFragment
}
managementType
meta
name
outlets {
...ChannelFragment
}
pairs {
...PairFragment
}
teamMembers {
...TeamMemberFragment
}
updatedAt
}
appId
clientMutationId
err
err_code
integrationId
ok
}
}
Variables
{"input": PutAppIntegrationInput}
Response
{
"data": {
"putAppIntegration": {
"app": App,
"appId": "4",
"clientMutationId": 4,
"err": "abc123",
"err_code": 987,
"integrationId": "4",
"ok": 987
}
}
}
updateAppIntegration
No longer supported
Description
A function to update app integration.\n Currently deprecated.\n
scope
["api:admin", "integration:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateAppIntegrationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAppIntegrationInput! |
Example
Query
mutation UpdateAppIntegration($input: UpdateAppIntegrationInput!) {
updateAppIntegration(input: $input) {
app {
_id
activated
createdAt
dataSource {
...DataSourceFragment
}
dataSources {
...DataSourceFragment
}
description
etag
id
inlets {
...ChannelFragment
}
integrations
managedBy {
...PartnerFragment
}
managementType
meta
name
outlets {
...ChannelFragment
}
pairs {
...PairFragment
}
teamMembers {
...TeamMemberFragment
}
updatedAt
}
clientMutationId
}
}
Variables
{"input": UpdateAppIntegrationInput}
Response
{
"data": {
"updateAppIntegration": {
"app": App,
"clientMutationId": "4"
}
}
}
updateAppIntegrationMeta
Description
A function to update App Integration Meta.\n
scope
["api:admin", "appIntegration:update"]
rate limit
10 call(s) per app per mintue
Response
Returns an UpdateAppIntegrationMetaPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAppIntegrationMetaInput! |
Example
Query
mutation UpdateAppIntegrationMeta($input: UpdateAppIntegrationMetaInput!) {
updateAppIntegrationMeta(input: $input) {
appIntegration {
_id
alias
app {
...AppFragment
}
appId
author {
...AuthorFragment
}
authorId
build
builderSidebarView {
...IntegrationViewFragment
}
changelog
channel {
...ChannelFragment
}
createdAt
customView {
...IntegrationViewFragment
}
dashboardView {
...IntegrationViewFragment
}
defaultResourceTemplate {
...ResourceTemplateFragment
}
description
endpoints {
...IntegrationEndpointsFragment
}
etag
features
functionString
hooks {
...HookFragment
}
icon
id
inbox {
...InboxIntegrationFragment
}
integrationDescription
integrationId
integrationKey
integrationName
integration_id
isLatestPublished
latestPublished
meta
platformSettingsView
privacyPolicyUrl
readme
resourceTemplates {
...ResourceTemplateFragment
}
scopes
secret
settingsSchema
settingsValidatorFunctionString
settingsView
signature
supportEmail
supportTicketing
supportedMediaTypes {
...SupportedMediaTypesFragment
}
termsAndConditionsUrl
trees {
...IntegrationTreeFragment
}
updatedAt
version
websiteUrl
}
clientMutationId
}
}
Variables
{"input": UpdateAppIntegrationMetaInput}
Response
{
"data": {
"updateAppIntegrationMeta": {
"appIntegration": AppIntegration,
"clientMutationId": 4
}
}
}
Boradcast
createAudience
Description
A function to create audience.\n
scope
["api:admin", "audience:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateAudiencePayload
Arguments
| Name | Description |
|---|---|
input - CreateAudienceInput! |
Example
Query
mutation CreateAudience($input: CreateAudienceInput!) {
createAudience(input: $input) {
audience {
_id
app {
...AppFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
description
etag
filter {
...AudienceFilterFragment
}
id
memberIds
members {
...MemberConnectionFragment
}
name
source
static
tags
updatedAt
}
clientMutationId
newAudienceResult {
audienceId
failedMembers {
...FailedMemberFragment
}
newMemberIds
removedMemberIds
updatedMemberIds
}
}
}
Variables
{"input": CreateAudienceInput}
Response
{
"data": {
"createAudience": {
"audience": Audience,
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult
}
}
}
createBroadcast
Description
A function to create broadcast.\n
scope
["api:admin", "push:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateBroadcastPayload
Arguments
| Name | Description |
|---|---|
input - CreateBroadcastInput! |
Example
Query
mutation CreateBroadcast($input: CreateBroadcastInput!) {
createBroadcast(input: $input) {
broadcast {
_id
agendaMeta
agendas {
...AgendaFragment
}
app {
...AppFragment
}
appId
childSubscriptionPushIds
childSubscriptionPushes {
...SubscriptionPushFragment
}
createdAt
description
errorStats {
...SubscriptionPushErrorStatsFragment
}
errors {
...SubscriptionPushErrorFragment
}
etag
excludeAudiences {
...AudienceFragment
}
fbMessageTag
fbOTNTags
filter {
...AudienceFilterFragment
}
id
includeAudiences {
...AudienceFragment
}
interacted
interactedCount
memberCount
memberIds
members {
...MemberConnectionFragment
}
messages
messagesHydrated {
...MessageFragment
}
name
parentSubscriptionPush {
...SubscriptionPushFragment
}
parentSubscriptionPushId
priority
read
readCount
scheduleAt
sent
sentCount
sentEnd
sentStart
source
tags
updatedAt
}
clientMutationId
newAudienceResult {
audienceId
failedMembers {
...FailedMemberFragment
}
newMemberIds
removedMemberIds
updatedMemberIds
}
}
}
Variables
{"input": CreateBroadcastInput}
Response
{
"data": {
"createBroadcast": {
"broadcast": SubscriptionPush,
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult
}
}
}
createRetryAudience
Description
A function to create retry audience from subscription push.\n
scope
["api:admin", "audience:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateRetryAudiencePayload
Arguments
| Name | Description |
|---|---|
input - CreateRetryAudienceInput! |
Example
Query
mutation CreateRetryAudience($input: CreateRetryAudienceInput!) {
createRetryAudience(input: $input) {
audiences {
_id
app {
...AppFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
description
etag
filter {
...AudienceFilterFragment
}
id
memberIds
members {
...MemberConnectionFragment
}
name
source
static
tags
updatedAt
}
clientMutationId
}
}
Variables
{"input": CreateRetryAudienceInput}
Response
{
"data": {
"createRetryAudience": {
"audiences": [Audience],
"clientMutationId": 4
}
}
}
createSubscriptionPush
Description
A function to create subscription push.\n
scope
["api:admin", "push:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - CreateSubscriptionPushInput! |
Example
Query
mutation CreateSubscriptionPush($input: CreateSubscriptionPushInput!) {
createSubscriptionPush(input: $input) {
clientMutationId
newAudienceResult {
audienceId
failedMembers {
...FailedMemberFragment
}
newMemberIds
removedMemberIds
updatedMemberIds
}
subscriptionPush {
_id
agendaMeta
agendas {
...AgendaFragment
}
app {
...AppFragment
}
appId
childSubscriptionPushIds
childSubscriptionPushes {
...SubscriptionPushFragment
}
createdAt
description
errorStats {
...SubscriptionPushErrorStatsFragment
}
errors {
...SubscriptionPushErrorFragment
}
etag
excludeAudiences {
...AudienceFragment
}
fbMessageTag
fbOTNTags
filter {
...AudienceFilterFragment
}
id
includeAudiences {
...AudienceFragment
}
interacted
interactedCount
memberCount
memberIds
members {
...MemberConnectionFragment
}
messages
messagesHydrated {
...MessageFragment
}
name
parentSubscriptionPush {
...SubscriptionPushFragment
}
parentSubscriptionPushId
priority
read
readCount
scheduleAt
sent
sentCount
sentEnd
sentStart
source
tags
updatedAt
}
}
}
Variables
{"input": CreateSubscriptionPushInput}
Response
{
"data": {
"createSubscriptionPush": {
"clientMutationId": "4",
"newAudienceResult": NewAudienceResult,
"subscriptionPush": SubscriptionPush
}
}
}
deleteAudience
Description
A function to delete audience.\n
scope
["api:admin", "audience:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteAudiencePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAudienceInput! |
Example
Query
mutation DeleteAudience($input: DeleteAudienceInput!) {
deleteAudience(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteAudienceInput}
Response
{
"data": {
"deleteAudience": {
"clientMutationId": "4"
}
}
}
deleteBroadcast
Description
A function to delete broadcast.\n
scope
["api:admin", "push:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - DeleteBroadcastInput! |
Example
Query
mutation DeleteBroadcast($input: DeleteBroadcastInput!) {
deleteBroadcast(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteBroadcastInput}
Response
{
"data": {
"deleteBroadcast": {
"clientMutationId": "4"
}
}
}
deleteSubscriptionPush
Description
A function to delete subscription push.\n
scope
["api:admin", "push:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - DeleteSubscriptionPushInput! |
Example
Query
mutation DeleteSubscriptionPush($input: DeleteSubscriptionPushInput!) {
deleteSubscriptionPush(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteSubscriptionPushInput}
Response
{
"data": {
"deleteSubscriptionPush": {
"clientMutationId": "4"
}
}
}
updateAudience
Description
A function to update audience.\n
scope
["api:admin", "audience:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateAudiencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAudienceInput! |
Example
Query
mutation UpdateAudience($input: UpdateAudienceInput!) {
updateAudience(input: $input) {
audience {
_id
app {
...AppFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
description
etag
filter {
...AudienceFilterFragment
}
id
memberIds
members {
...MemberConnectionFragment
}
name
source
static
tags
updatedAt
}
clientMutationId
newAudienceResult {
audienceId
failedMembers {
...FailedMemberFragment
}
newMemberIds
removedMemberIds
updatedMemberIds
}
}
}
Variables
{"input": UpdateAudienceInput}
Response
{
"data": {
"updateAudience": {
"audience": Audience,
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult
}
}
}
updateBroadcast
Description
A function to update broadcast.\n
scope
["api:admin", "push:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateBroadcastPayload
Arguments
| Name | Description |
|---|---|
input - UpdateBroadcastInput! |
Example
Query
mutation UpdateBroadcast($input: UpdateBroadcastInput!) {
updateBroadcast(input: $input) {
broadcast {
_id
agendaMeta
agendas {
...AgendaFragment
}
app {
...AppFragment
}
appId
childSubscriptionPushIds
childSubscriptionPushes {
...SubscriptionPushFragment
}
createdAt
description
errorStats {
...SubscriptionPushErrorStatsFragment
}
errors {
...SubscriptionPushErrorFragment
}
etag
excludeAudiences {
...AudienceFragment
}
fbMessageTag
fbOTNTags
filter {
...AudienceFilterFragment
}
id
includeAudiences {
...AudienceFragment
}
interacted
interactedCount
memberCount
memberIds
members {
...MemberConnectionFragment
}
messages
messagesHydrated {
...MessageFragment
}
name
parentSubscriptionPush {
...SubscriptionPushFragment
}
parentSubscriptionPushId
priority
read
readCount
scheduleAt
sent
sentCount
sentEnd
sentStart
source
tags
updatedAt
}
clientMutationId
}
}
Variables
{"input": UpdateBroadcastInput}
Response
{
"data": {
"updateBroadcast": {
"broadcast": SubscriptionPush,
"clientMutationId": 4
}
}
}
updateSubscriptionPush
Description
A function to update subscription push.\n
scope
["api:admin", "push:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSubscriptionPushInput! |
Example
Query
mutation UpdateSubscriptionPush($input: UpdateSubscriptionPushInput!) {
updateSubscriptionPush(input: $input) {
clientMutationId
subscriptionPush {
_id
agendaMeta
agendas {
...AgendaFragment
}
app {
...AppFragment
}
appId
childSubscriptionPushIds
childSubscriptionPushes {
...SubscriptionPushFragment
}
createdAt
description
errorStats {
...SubscriptionPushErrorStatsFragment
}
errors {
...SubscriptionPushErrorFragment
}
etag
excludeAudiences {
...AudienceFragment
}
fbMessageTag
fbOTNTags
filter {
...AudienceFilterFragment
}
id
includeAudiences {
...AudienceFragment
}
interacted
interactedCount
memberCount
memberIds
members {
...MemberConnectionFragment
}
messages
messagesHydrated {
...MessageFragment
}
name
parentSubscriptionPush {
...SubscriptionPushFragment
}
parentSubscriptionPushId
priority
read
readCount
scheduleAt
sent
sentCount
sentEnd
sentStart
source
tags
updatedAt
}
}
}
Variables
{"input": UpdateSubscriptionPushInput}
Response
{
"data": {
"updateSubscriptionPush": {
"clientMutationId": 4,
"subscriptionPush": SubscriptionPush
}
}
}
Channel
createChannel
Description
A function to create channel.\n
scope
["api:admin", "channel:createChannel"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateChannelPayload
Arguments
| Name | Description |
|---|---|
input - CreateChannelInput! |
Example
Query
mutation CreateChannel($input: CreateChannelInput!) {
createChannel(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": CreateChannelInput}
Response
{
"data": {
"createChannel": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
createChannelEnvironment
Description
A function to create a new channel environment.\n
scope
["api:admin", "channel:createEnvironment"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - CreateChannelEnvironmentInput! |
Example
Query
mutation CreateChannelEnvironment($input: CreateChannelEnvironmentInput!) {
createChannelEnvironment(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": CreateChannelEnvironmentInput}
Response
{
"data": {
"createChannelEnvironment": {
"channel": Channel,
"clientMutationId": "4",
"error": GenericError
}
}
}
deleteChannel
Description
A function to delete a channel.\n
scope
["api:admin", "channel:deleteChannel"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteChannelPayload
Arguments
| Name | Description |
|---|---|
input - DeleteChannelInput! |
Example
Query
mutation DeleteChannel($input: DeleteChannelInput!) {
deleteChannel(input: $input) {
clientMutationId
error {
code
message
name
}
errorMessage
errors {
code
message
meta
name
}
forceRequest
}
}
Variables
{"input": DeleteChannelInput}
Response
{
"data": {
"deleteChannel": {
"clientMutationId": 4,
"error": GenericError,
"errorMessage": "abc123",
"errors": [endpointError],
"forceRequest": false
}
}
}
deleteChannelEnvironment
Description
A function to delete a new channel environment.\n
scope
["api:admin", "channel:deleteEnvironment"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteChannelEnvironmentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteChannelEnvironmentInput! |
Example
Query
mutation DeleteChannelEnvironment($input: DeleteChannelEnvironmentInput!) {
deleteChannelEnvironment(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
forceRequest
}
}
Variables
{"input": DeleteChannelEnvironmentInput}
Response
{
"data": {
"deleteChannelEnvironment": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError,
"forceRequest": true
}
}
}
subscribeChannel
Description
A function to subscribe channel from platform integration
scope
["api:admin", "channel:updatePlatformInfo"]
rate limit
10 call(s) per app per mintue
Response
Returns a SubscribeChannelPayload
Arguments
| Name | Description |
|---|---|
input - SubscribeChannelInput! |
Example
Query
mutation SubscribeChannel($input: SubscribeChannelInput!) {
subscribeChannel(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": SubscribeChannelInput}
Response
{
"data": {
"subscribeChannel": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
unsubscribeChannel
Description
A function to unsubscribe a channel.\n
scope
["api:admin", "channel:Unsubscribe"]
rate limit
5 call(s) per app per mintue
Response
Returns an UnsubscribeChannelPayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeChannelInput! |
Example
Query
mutation UnsubscribeChannel($input: UnsubscribeChannelInput!) {
unsubscribeChannel(input: $input) {
clientMutationId
error {
code
message
name
}
errorMessage
errors {
code
message
meta
name
}
forceRequest
}
}
Variables
{"input": UnsubscribeChannelInput}
Response
{
"data": {
"unsubscribeChannel": {
"clientMutationId": 4,
"error": GenericError,
"errorMessage": "xyz789",
"errors": [endpointError],
"forceRequest": true
}
}
}
updateChannel
Description
A function to update channel.\n
scope
["api:admin", "channel:updateAvailabilities", "channel:updateBasicInfo"]
Input params scope
"on"
scope: ["api:admin", "channel:updateAvailabilities"]
"name"
scope: ["api:admin", "channel:updateBasicInfo"]
"description"
scope: ["api:admin", "channel:updateBasicInfo"]
"tags"
scope: ["api:admin", "channel:updateBasicInfo"]
"meta"
scope: ["api:admin", "channel:updateBasicInfo"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelInput! |
Example
Query
mutation UpdateChannel($input: UpdateChannelInput!) {
updateChannel(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": UpdateChannelInput}
Response
{
"data": {
"updateChannel": {
"channel": Channel,
"clientMutationId": "4",
"error": GenericError
}
}
}
updateChannelEnvironment
Description
A function to update channel environment.\n
scope
["api:admin", "channel:updateTreeSettings", "channel:updateBasicInfo", "channel:updateAvailabilities", "channel:updateDetail"]
Input params scope
"on"
scope: ["api:admin", "channel:updateAvailabilities"]
"availability"
scope: ["api:admin", "channel:updateAvailabilities"]
"name"
scope: ["api:admin", "channel:updateBasicInfo"]
"hooks"
scope: ["api:admin", "channel:updateDetail"]
"webhooks"
scope: ["api:admin", "channel:updateDetail"]
"treeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"globalNodeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"offTreeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"offGlobalNodeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"livechatTreeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"livechatGlobalNodeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"coreVersion"
scope: ["api:admin", "channel:updateTreeSettings"]
"meta"
scope: ["api:admin", "channel:updateTreeSettings"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentInput! |
Example
Query
mutation UpdateChannelEnvironment($input: UpdateChannelEnvironmentInput!) {
updateChannelEnvironment(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": UpdateChannelEnvironmentInput}
Response
{
"data": {
"updateChannelEnvironment": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
updateChannelEnvironmentHooks
Description
A function to update channel environment hooks.\n
scope
["api:admin", "channel:updateDetail"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentHooksInput! |
Example
Query
mutation UpdateChannelEnvironmentHooks($input: UpdateChannelEnvironmentHooksInput!) {
updateChannelEnvironmentHooks(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": UpdateChannelEnvironmentHooksInput}
Response
{
"data": {
"updateChannelEnvironmentHooks": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
updateChannelEnvironmentLivechatTreeGlobalNode
Description
A function to update channel environment livechat trees and global nodes.\n
scope
["api:admin", "channel:updateTreeSettings"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentLivechatTreeGlobalNodeInput! |
Example
Query
mutation UpdateChannelEnvironmentLivechatTreeGlobalNode($input: UpdateChannelEnvironmentLivechatTreeGlobalNodeInput!) {
updateChannelEnvironmentLivechatTreeGlobalNode(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{
"input": UpdateChannelEnvironmentLivechatTreeGlobalNodeInput
}
Response
{
"data": {
"updateChannelEnvironmentLivechatTreeGlobalNode": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
updateChannelEnvironmentOffTreeGlobalNode
Description
A function to update channel environment off trees and global nodes.\n
scope
["api:admin", "channel:updateTreeSettings"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentOffTreeGlobalNodeInput! |
Example
Query
mutation UpdateChannelEnvironmentOffTreeGlobalNode($input: UpdateChannelEnvironmentOffTreeGlobalNodeInput!) {
updateChannelEnvironmentOffTreeGlobalNode(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": UpdateChannelEnvironmentOffTreeGlobalNodeInput}
Response
{
"data": {
"updateChannelEnvironmentOffTreeGlobalNode": {
"channel": Channel,
"clientMutationId": "4",
"error": GenericError
}
}
}
updateChannelEnvironmentTreeGlobalNode
Description
A function to update channel environment trees and global nodes.\n
scope
["api:admin", "channel:updateTreeSettings"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentTreeGlobalNodeInput! |
Example
Query
mutation UpdateChannelEnvironmentTreeGlobalNode($input: UpdateChannelEnvironmentTreeGlobalNodeInput!) {
updateChannelEnvironmentTreeGlobalNode(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": UpdateChannelEnvironmentTreeGlobalNodeInput}
Response
{
"data": {
"updateChannelEnvironmentTreeGlobalNode": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
updateChannelEnvironmentWebhooks
Description
A function to update channel environment webhooks.\n
scope
["api:admin", "channel:updateDetail"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentWebhooksInput! |
Example
Query
mutation UpdateChannelEnvironmentWebhooks($input: UpdateChannelEnvironmentWebhooksInput!) {
updateChannelEnvironmentWebhooks(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": UpdateChannelEnvironmentWebhooksInput}
Response
{
"data": {
"updateChannelEnvironmentWebhooks": {
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
}
}
updateChannelIncomingWebhooks
Description
scope ["api:admin", "channel:updateDetail"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateChannelIncomingWebhookPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelIncomingWebhookInput! |
Example
Query
mutation UpdateChannelIncomingWebhooks($input: UpdateChannelIncomingWebhookInput!) {
updateChannelIncomingWebhooks(input: $input) {
channel {
_id
app {
...AppFragment
}
appId
appIntegrationAccessToken
archived
archivedAt
availability
broadcastGroups {
...ChannelBroadcastGroupFragment
}
channelSecret
connected
createdAt
description
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
etag
exclusiveLiveChat
globalNodes {
...NodeObjectFragment
}
id
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
info
inletGroup
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
livechatAgendas
locked
meta
name
on
priorityGroups {
...ChannelPriorityGroupFragment
}
relayWebhooks
sendOutletMessageViaBot
tags
trees {
...TreeFragment
}
type
updatedAt
verificationToken
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
wabaStatus
webhooks
}
clientMutationId
}
}
Variables
{"input": UpdateChannelIncomingWebhookInput}
Response
{
"data": {
"updateChannelIncomingWebhooks": {
"channel": Channel,
"clientMutationId": 4
}
}
}
Priority Group
createPriorityGroup
Description
A function to create priority group.\n
scope
["api:admin", "priorityGroup:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreatePriorityGroupPayload
Arguments
| Name | Description |
|---|---|
input - CreatePriorityGroupInput! |
Example
Query
mutation CreatePriorityGroup($input: CreatePriorityGroupInput!) {
createPriorityGroup(input: $input) {
clientMutationId
priorityGroup {
_id
app {
...AppFragment
}
channel {
...ChannelFragment
}
createdAt
description
etag
id
memberIds
members {
...MemberFragment
}
name
tags
updatedAt
}
}
}
Variables
{"input": CreatePriorityGroupInput}
Response
{
"data": {
"createPriorityGroup": {
"clientMutationId": "4",
"priorityGroup": PriorityGroup
}
}
}
deletePriorityGroup
Description
A function to delete priority group.\n
scope
["api:admin", "priorityGroup:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeletePriorityGroupPayload
Arguments
| Name | Description |
|---|---|
input - DeletePriorityGroupInput! |
Example
Query
mutation DeletePriorityGroup($input: DeletePriorityGroupInput!) {
deletePriorityGroup(input: $input) {
clientMutationId
}
}
Variables
{"input": DeletePriorityGroupInput}
Response
{
"data": {
"deletePriorityGroup": {
"clientMutationId": "4"
}
}
}
updatePriorityGroup
Description
A function to update priority group.\n
scope
["api:admin", "priorityGroup:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdatePriorityGroupPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePriorityGroupInput! |
Example
Query
mutation UpdatePriorityGroup($input: UpdatePriorityGroupInput!) {
updatePriorityGroup(input: $input) {
clientMutationId
priorityGroup {
_id
app {
...AppFragment
}
channel {
...ChannelFragment
}
createdAt
description
etag
id
memberIds
members {
...MemberFragment
}
name
tags
updatedAt
}
}
}
Variables
{"input": UpdatePriorityGroupInput}
Response
{
"data": {
"updatePriorityGroup": {
"clientMutationId": 4,
"priorityGroup": PriorityGroup
}
}
}
Data Source
aggregateDataSourceDocs
Description
A function to aggregate datasource documents.\n Format: https://docs.mongodb.com/manual/core/aggregation-pipeline/\n
scope
["api:admin", "datasource:api"]
rate limit
30 call(s) per app per mintue
Response
Returns an AggregateDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - AggregateDataSourceDocsInput! |
Example
Query
mutation AggregateDataSourceDocs($input: AggregateDataSourceDocsInput!) {
aggregateDataSourceDocs(input: $input) {
clientMutationId
result
}
}
Variables
{"input": AggregateDataSourceDocsInput}
Response
{
"data": {
"aggregateDataSourceDocs": {
"clientMutationId": "4",
"result": {}
}
}
}
createDataSource
Description
A function to create datasource.\n
scope
["api:admin", "datasource:api", "dataSource:createDatasource"]
rate limit
20 call(s) per app per mintue
Response
Returns a CreateDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - CreateDataSourceInput! |
Example
Query
mutation CreateDataSource($input: CreateDataSourceInput!) {
createDataSource(input: $input) {
clientMutationId
dataSource {
collectionName
data {
...DataSourceConnectionFragment
}
dataByQuery
description
name
shopifyIntegration
}
}
}
Variables
{"input": CreateDataSourceInput}
Response
{
"data": {
"createDataSource": {
"clientMutationId": 4,
"dataSource": DataSource
}
}
}
createDataSourceDoc
Description
A function to create datasource document.\n
scope
["api:admin", "datasource:api", "dataSource:createDoc"]
rate limit
30 call(s) per app per mintue
Response
Returns a CreateDataSourceDocPayload
Arguments
| Name | Description |
|---|---|
input - CreateDataSourceDocInput! |
Example
Query
mutation CreateDataSourceDoc($input: CreateDataSourceDocInput!) {
createDataSourceDoc(input: $input) {
clientMutationId
data
}
}
Variables
{"input": CreateDataSourceDocInput}
Response
{"data": {"createDataSourceDoc": {"clientMutationId": 4, "data": {}}}}
deleteDataSource
Description
A function to delete datasource.\n
scope
["api:admin", "datasource:api", "dataSource:deleteDatasource"]
rate limit
20 call(s) per app per mintue
Response
Returns a DeleteDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - DeleteDataSourceInput! |
Example
Query
mutation DeleteDataSource($input: DeleteDataSourceInput!) {
deleteDataSource(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteDataSourceInput}
Response
{
"data": {
"deleteDataSource": {
"clientMutationId": "4"
}
}
}
deleteDataSourceDocs
Description
A function to delete datasource documents by _id.\n
scope
["api:admin", "datasource:api", "dataSource:deleteDoc"]
rate limit
30 call(s) per app per mintue
Response
Returns a DeleteDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDataSourceDocsInput! |
Example
Query
mutation DeleteDataSourceDocs($input: DeleteDataSourceDocsInput!) {
deleteDataSourceDocs(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteDataSourceDocsInput}
Response
{"data": {"deleteDataSourceDocs": {"clientMutationId": 4}}}
findAndModifyDataSourceDoc
Description
A function to find and modify datasource document.\n Format: https://docs.mongodb.com/manual/reference/method/db.collection.findAndModify/\n
scope
["api:admin", "datasource:api", "dateSource:updateDoc"]
rate limit
30 call(s) per app per mintue
Response
Returns a FindAndModifyDataSourceDocPayload
Arguments
| Name | Description |
|---|---|
input - FindAndModifyDataSourceDocInput! |
Example
Query
mutation FindAndModifyDataSourceDoc($input: FindAndModifyDataSourceDocInput!) {
findAndModifyDataSourceDoc(input: $input) {
clientMutationId
result
}
}
Variables
{"input": FindAndModifyDataSourceDocInput}
Response
{"data": {"findAndModifyDataSourceDoc": {"clientMutationId": 4, "result": {}}}}
importDataSource
Description
A function to import datasource documents.\n
scope
["api:admin", "datasource:api", "dataSource:importDatasource"]
rate limit
30 call(s) per app per mintue
Response
Returns an ImportDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - ImportDataSourceInput! |
Example
Query
mutation ImportDataSource($input: ImportDataSourceInput!) {
importDataSource(input: $input) {
clientMutationId
data
}
}
Variables
{"input": ImportDataSourceInput}
Response
{"data": {"importDataSource": {"clientMutationId": 4, "data": {}}}}
updateDataSource
Description
A function to update datasource.\n
scope
["api:admin", "datasource:api", "dataSource:updateDatasource"]
rate limit
20 call(s) per app per mintue
Response
Returns an UpdateDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - UpdateDataSourceInput! |
Example
Query
mutation UpdateDataSource($input: UpdateDataSourceInput!) {
updateDataSource(input: $input) {
clientMutationId
dataSource {
collectionName
data {
...DataSourceConnectionFragment
}
dataByQuery
description
name
shopifyIntegration
}
}
}
Variables
{"input": UpdateDataSourceInput}
Response
{
"data": {
"updateDataSource": {
"clientMutationId": 4,
"dataSource": DataSource
}
}
}
updateDataSourceDoc
Description
A function to update datasource document (replace) by _id.
scope
["api:admin", "datasource:api", "dataSource:updateDoc"]
rate limit
30 call(s) per app per mintue
Response
Returns an UpdateDataSourceDocPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDataSourceDocInput! |
Example
Query
mutation UpdateDataSourceDoc($input: UpdateDataSourceDocInput!) {
updateDataSourceDoc(input: $input) {
clientMutationId
data
}
}
Variables
{"input": UpdateDataSourceDocInput}
Response
{"data": {"updateDataSourceDoc": {"clientMutationId": 4, "data": {}}}}
updateDataSourceDocs
Description
A function to update datasource document.\n
scope
["api:admin", "datasource:api", "dateSource:updateDoc"]
rate limit
30 call(s) per app per mintue
Response
Returns an UpdateDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDataSourceDocsInput! |
Example
Query
mutation UpdateDataSourceDocs($input: UpdateDataSourceDocsInput!) {
updateDataSourceDocs(input: $input) {
clientMutationId
result
}
}
Variables
{"input": UpdateDataSourceDocsInput}
Response
{"data": {"updateDataSourceDocs": {"clientMutationId": 4, "result": {}}}}
upsertDataSourceDocs
Description
A function to upsert datasource document.\n
scope
["api:admin", "datasource:api", "dataSource:createDoc", "dateSource:updateDoc"]
rate limit
30 call(s) per app per mintue
Response
Returns an UpsertDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - UpsertDataSourceDocsInput! |
Example
Query
mutation UpsertDataSourceDocs($input: UpsertDataSourceDocsInput!) {
upsertDataSourceDocs(input: $input) {
clientMutationId
result
}
}
Variables
{"input": UpsertDataSourceDocsInput}
Response
{
"data": {
"upsertDataSourceDocs": {
"clientMutationId": "4",
"result": {}
}
}
}
Locale Group
createLocaleGroup
Description
A function to create locale group.\n
scope
["api:admin", "localeGroup:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateLocaleGroupPayload
Arguments
| Name | Description |
|---|---|
input - CreateLocaleGroupInput! |
Example
Query
mutation CreateLocaleGroup($input: CreateLocaleGroupInput!) {
createLocaleGroup(input: $input) {
clientMutationId
localeGroup {
_id
app {
...AppFragment
}
createdAt
etag
id
locales
name
updatedAt
}
}
}
Variables
{"input": CreateLocaleGroupInput}
Response
{
"data": {
"createLocaleGroup": {
"clientMutationId": "4",
"localeGroup": LocaleGroup
}
}
}
deleteLocaleGroup
Description
A function to delete locale group.\n
scope
["api:admin", "localeGroup:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteLocaleGroupPayload
Arguments
| Name | Description |
|---|---|
input - DeleteLocaleGroupInput! |
Example
Query
mutation DeleteLocaleGroup($input: DeleteLocaleGroupInput!) {
deleteLocaleGroup(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteLocaleGroupInput}
Response
{
"data": {
"deleteLocaleGroup": {
"clientMutationId": "4"
}
}
}
updateLocaleGroup
Description
A function to update locale group.\n
scope
["api:admin", "localeGroup:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateLocaleGroupPayload
Arguments
| Name | Description |
|---|---|
input - UpdateLocaleGroupInput! |
Example
Query
mutation UpdateLocaleGroup($input: UpdateLocaleGroupInput!) {
updateLocaleGroup(input: $input) {
clientMutationId
localeGroup {
_id
app {
...AppFragment
}
createdAt
etag
id
locales
name
updatedAt
}
}
}
Variables
{"input": UpdateLocaleGroupInput}
Response
{
"data": {
"updateLocaleGroup": {
"clientMutationId": "4",
"localeGroup": LocaleGroup
}
}
}
Media Library
deleteFiles
Description
A function to batch delete files for an app.\n
scope
["api:admin", "mediaLibrary:delete"]
rate limit
30 call(s) per app per mintue
Response
Returns a DeleteFilesPayload
Arguments
| Name | Description |
|---|---|
input - DeleteFilesInput |
Example
Query
mutation DeleteFiles($input: DeleteFilesInput) {
deleteFiles(input: $input) {
clientMutationId
errors
}
}
Variables
{"input": DeleteFilesInput}
Response
{"data": {"deleteFiles": {"clientMutationId": 4, "errors": {}}}}
getPresignedURLForUpload
Description
A function to get pre-signed URL for uploading files to the media library of an app.\n
scope
["api:admin", "mediaLibrary:create"]
rate limit
30 call(s) per app per mintue
Response
Returns an PresignedURLForUploadPayload
Arguments
| Name | Description |
|---|---|
input - PresignedURLForUploadInput |
Example
Query
mutation GetPresignedURLForUpload($input: PresignedURLForUploadInput) {
getPresignedURLForUpload(input: $input) {
clientMutationId
error {
code
message
name
}
fields
ok
url
}
}
Variables
{"input": PresignedURLForUploadInput}
Response
{
"data": {
"getPresignedURLForUpload": {
"clientMutationId": 4,
"error": GenericError,
"fields": {},
"ok": 123,
"url": "abc123"
}
}
}
Members
addMemberTags
Description
A function to add tags to member.\n
scope
["api:admin", "member:updateDetails", "member:write"]
rate limit
10 call(s) per app per mintue
Response
Returns a ModifyMemberTagsPayload
Arguments
| Name | Description |
|---|---|
input - ModifyMemberTagsInput! |
Example
Query
mutation AddMemberTags($input: ModifyMemberTagsInput!) {
addMemberTags(input: $input) {
clientMutationId
err
err_code
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
memberId
ok
}
}
Variables
{"input": ModifyMemberTagsInput}
Response
{
"data": {
"addMemberTags": {
"clientMutationId": 4,
"err": "xyz789",
"err_code": 123,
"member": Member,
"memberId": 4,
"ok": 987
}
}
}
addNoteToMember
Description
scope ["api:admin", "member:manageNote"]
Input params scope
"note"
scope: ["api:admin", "note:create"]
rate limit
60 call(s) per app per mintue
Response
Returns an AddNoteToMemberPayload
Arguments
| Name | Description |
|---|---|
input - AddNoteToMemberInput! |
Example
Query
mutation AddNoteToMember($input: AddNoteToMemberInput!) {
addNoteToMember(input: $input) {
clientMutationId
error {
code
message
name
}
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
}
}
Variables
{"input": AddNoteToMemberInput}
Response
{
"data": {
"addNoteToMember": {
"clientMutationId": "4",
"error": GenericError,
"member": Member
}
}
}
batchCreateChat
Description
A function to batch update member.\n
scope
["api:admin", "chat:create"]
Array Size Limit max
Input params array size limit
"chats"
max: 80
Response
Returns a BatchCreateChatPayload
Arguments
| Name | Description |
|---|---|
input - BatchCreateChatInput! |
Example
Query
mutation BatchCreateChat($input: BatchCreateChatInput!) {
batchCreateChat(input: $input) {
chatIds
clientMutationId
}
}
Variables
{"input": BatchCreateChatInput}
Response
{
"data": {
"batchCreateChat": {
"chatIds": ["4"],
"clientMutationId": 4
}
}
}
batchUpdateMember
Description
A function to batch update member.\n
scope
["api:admin", "member:update", "member:updateProfile"]
Input params scope
"tags"
scope: ["api:admin", "member:update", "member:updateProfile"]
"locale"
scope: ["api:admin", "member:update", "member:updateProfile"]
"gender"
scope: ["api:admin", "member:update", "member:updateProfile"]
rate limit
10 call(s) per app per mintue
Array Size Limit max
Input params array size limit
"memberIds"
max: 100
"externalIds"
max: 100
"tags"
max: 10
Response
Returns a BatchUpdateMemberPayload
Arguments
| Name | Description |
|---|---|
input - BatchUpdateMemberInput! |
Example
Query
mutation BatchUpdateMember($input: BatchUpdateMemberInput!) {
batchUpdateMember(input: $input) {
clientMutationId
}
}
Variables
{"input": BatchUpdateMemberInput}
Response
{
"data": {
"batchUpdateMember": {
"clientMutationId": "4"
}
}
}
createMember
Description
A function to create member.\n
scope
["api:admin", "member:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateMemberPayload
Arguments
| Name | Description |
|---|---|
input - CreateMemberInput! |
Example
Query
mutation CreateMember($input: CreateMemberInput!) {
createMember(input: $input) {
clientMutationId
error {
code
message
name
}
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
}
}
Variables
{"input": CreateMemberInput}
Response
{
"data": {
"createMember": {
"clientMutationId": 4,
"error": GenericError,
"member": Member
}
}
}
deleteMember
Description
A function to permanently delete a member. The conversation history of this member will also be deleted.\n
scope
["api:admin", "member:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteMemberPayload
Arguments
| Name | Description |
|---|---|
input - DeleteMemberInput! |
Example
Query
mutation DeleteMember($input: DeleteMemberInput!) {
deleteMember(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteMemberInput}
Response
{
"data": {
"deleteMember": {
"clientMutationId": "4"
}
}
}
deleteMembers
Description
A function to permanently delete members in batch with time filter. The conversation history of these members will also be deleted.\nNOTE: if no criteria / createdAtFrom / createdAtTo / updatedAtFrom / updatedAtTo is specified, ALL members of the app will be deleted.
scope
["api:admin", "member:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteMembersPayload
Arguments
| Name | Description |
|---|---|
input - DeleteMembersInput! |
Example
Query
mutation DeleteMembers($input: DeleteMembersInput!) {
deleteMembers(input: $input) {
backgroundTask {
_id
app {
...AppFragment
}
appId
createdAt
data
endAt
etag
id
message
meta
runAt
status
type
updatedAt
}
clientMutationId
error {
code
message
name
}
}
}
Variables
{"input": DeleteMembersInput}
Response
{
"data": {
"deleteMembers": {
"backgroundTask": BackgroundTask,
"clientMutationId": "4",
"error": GenericError
}
}
}
exportChats
Description
A function to export chat history (max return 1000 rows).\n
scope
["api:admin", "conversation:read"]
rate limit
5 call(s) per app per mintue
Response
Returns an ExportChatsPayload
Arguments
| Name | Description |
|---|---|
input - ExportChatsInput! |
Example
Query
mutation ExportChats($input: ExportChatsInput!) {
exportChats(input: $input) {
url
urls
}
}
Variables
{"input": ExportChatsInput}
Response
{
"data": {
"exportChats": {
"url": "xyz789",
"urls": ["xyz789"]
}
}
}
importMembers
Description
A function to import member.\n
scope
["api:admin", "member:import"]
rate limit
5 call(s) per app per mintue
Response
Returns an ImportMembersPayload
Arguments
| Name | Description |
|---|---|
input - ImportMembersInput! |
Example
Query
mutation ImportMembers($input: ImportMembersInput!) {
importMembers(input: $input) {
backgroundTask {
_id
app {
...AppFragment
}
appId
createdAt
data
endAt
etag
id
message
meta
runAt
status
type
updatedAt
}
clientMutationId
}
}
Variables
{"input": ImportMembersInput}
Response
{
"data": {
"importMembers": {
"backgroundTask": BackgroundTask,
"clientMutationId": "4"
}
}
}
mergeMembersByExternalIds
Description
A function to merge members using two externalIds.\n
scope
["api:admin", "member:merge"]
rate limit
5 call(s) per app per mintue
Response
Returns a MergeMembersByExternalIdsPayload
Arguments
| Name | Description |
|---|---|
input - MergeMembersByExternalIdsInput! |
Example
Query
mutation MergeMembersByExternalIds($input: MergeMembersByExternalIdsInput!) {
mergeMembersByExternalIds(input: $input) {
action
clientMutationId
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
}
}
Variables
{"input": MergeMembersByExternalIdsInput}
Response
{
"data": {
"mergeMembersByExternalIds": {
"action": "xyz789",
"clientMutationId": "4",
"member": Member
}
}
}
removeMemberTags
Description
A function to remove tags to member.\n
scope
["api:admin", "member:updateDetails", "member:write"]
rate limit
10 call(s) per app per mintue
Response
Returns a ModifyMemberTagsPayload
Arguments
| Name | Description |
|---|---|
input - ModifyMemberTagsInput! |
Example
Query
mutation RemoveMemberTags($input: ModifyMemberTagsInput!) {
removeMemberTags(input: $input) {
clientMutationId
err
err_code
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
memberId
ok
}
}
Variables
{"input": ModifyMemberTagsInput}
Response
{
"data": {
"removeMemberTags": {
"clientMutationId": 4,
"err": "xyz789",
"err_code": 987,
"member": Member,
"memberId": "4",
"ok": 123
}
}
}
toggleLiveChat
Description
A function to toggle member live chat state.\n
scope
["api:admin", "member:updateDetails", "member:ToggleLiveChat"]
rate limit
60 call(s) per app per mintue
Response
Returns a toggleLiveChatPayload
Arguments
| Name | Description |
|---|---|
input - toggleLiveChatInput! |
Example
Query
mutation ToggleLiveChat($input: toggleLiveChatInput!) {
toggleLiveChat(input: $input) {
clientMutationId
err
err_code
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
memberId
ok
}
}
Variables
{"input": toggleLiveChatInput}
Response
{
"data": {
"toggleLiveChat": {
"clientMutationId": 4,
"err": "xyz789",
"err_code": 123,
"member": Member,
"memberId": "4",
"ok": 123
}
}
}
updateMember
Description
A function to update member.\n
scope
["api:admin", "member:update", "member:updateProfile", "member:updateBotMeta", "member:updateMeta"]
Input params scope
"profile"
scope: ["api:admin", "member:update", "member:updateProfile"]
"tags"
scope: ["api:admin", "member:update", "member:updateProfile"]
"meta"
scope: ["api:admin", "member:update", "member:updateMeta"]
"botMeta"
scope: ["api:admin", "member:update", "member:updateBotMeta"]
"admin"
scope: ["api:admin", "member:update"]
"group"
scope: ["api:admin", "member:update"]
"firstName"
scope: ["api:admin", "member:update", "member:updateProfile"]
"lastName"
scope: ["api:admin", "member:update", "member:updateProfile"]
"profilePic"
scope: ["api:admin", "member:update", "member:updateProfile"]
"gender"
scope: ["api:admin", "member:update", "member:updateProfile"]
"locale"
scope: ["api:admin", "member:update", "member:updateProfile"]
"email"
scope: ["api:admin", "member:update", "member:updateProfile"]
"profilePicString"
scope: ["api:admin", "member:update", "member:updateProfile"]
rate limit
10 call(s) per app per mintue
Response
Returns an UpdateMemberPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMemberInput! |
Example
Query
mutation UpdateMember($input: UpdateMemberInput!) {
updateMember(input: $input) {
clientMutationId
member {
_id
admin {
...AdminFragment
}
adminId
app {
...AppFragment
}
appId
assignment
botId
botMeta {
...BotMetaFragment
}
channel {
...ChannelFragment
}
channelId
createdAt
customLocale
email
etag
externalId
fbId
fbOTNTokens {
...FbOTNTokenFragment
}
firstName
gender
group {
...GroupFragment
}
id
inboxProfile {
...InboxMemberProfileFragment
}
inletGroup
lastName
locale
meta
name
notes {
...NoteFragment
}
platform
profile {
...MemberProfileFragment
}
profilePic
profilePicString
tags
updatedAt
}
memberRaw
}
}
Variables
{"input": UpdateMemberInput}
Response
{
"data": {
"updateMember": {
"clientMutationId": 4,
"member": Member,
"memberRaw": {}
}
}
}
updateMembers
Description
A function to update members.\n
scope
["api:admin", "member:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateMembersPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMembersInput! |
Example
Query
mutation UpdateMembers($input: UpdateMembersInput!) {
updateMembers(input: $input) {
clientMutationId
result
}
}
Variables
{"input": UpdateMembersInput}
Response
{"data": {"updateMembers": {"clientMutationId": 4, "result": {}}}}
updateNote
Description
scope ["api:admin", "note:update"]
rate limit
60 call(s) per app per mintue
Response
Returns an UpdateNotePayload
Arguments
| Name | Description |
|---|---|
input - UpdateNoteInput! |
Example
Query
mutation UpdateNote($input: UpdateNoteInput!) {
updateNote(input: $input) {
clientMutationId
error {
code
message
name
}
note {
_id
authorId
content
createdAt
etag
id
updatedAt
}
}
}
Variables
{"input": UpdateNoteInput}
Response
{
"data": {
"updateNote": {
"clientMutationId": "4",
"error": GenericError,
"note": Note
}
}
}
Notification
createNotification
Description
A function to create notifiction for an app.\n
scope
["api:admin", "notification:create"]
rate limit
10 call(s) per app per mintue
Response
Returns a CreateNotificationPayload
Arguments
| Name | Description |
|---|---|
input - CreateNotificationInput |
Example
Query
mutation CreateNotification($input: CreateNotificationInput) {
createNotification(input: $input) {
clientMutationId
notification {
_id
app {
...AppFragment
}
appId
backgroundTaskId
buttons {
...NotificationButtonFragment
}
color
createdAt
etag
id
linkTo
message
new
status
title
type
updatedAt
}
}
}
Variables
{"input": CreateNotificationInput}
Response
{
"data": {
"createNotification": {
"clientMutationId": "4",
"notification": Notification
}
}
}
Tree
batchCreateAppIntegrationForTree
Description
A function to install required integrations and then import tree.\n
scope
["api:admin", "botbuilder:manage", "tree:create", "node:create", "trigger:create", "condition:create", "action:create", "response:create", "localeGroup:create"]
Input params scope
"trees"
scope: ["api:admin", "botbuilder:manage", "tree:create"]
"nodes"
scope: ["api:admin", "botbuilder:manage", "node:create"]
"triggers"
scope: ["api:admin", "botbuilder:manage", "trigger:create"]
"conditions"
scope: ["api:admin", "botbuilder:manage", "condition:create"]
"actions"
scope: ["api:admin", "botbuilder:manage", "action:create"]
"responses"
scope: ["api:admin", "botbuilder:manage", "response:create"]
"localeGroups"
scope: ["api:admin", "botbuilder:manage", "localeGroup:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a BatchCreateAppIntegrationForTreePayload
Arguments
| Name | Description |
|---|---|
input - BatchCreateAppIntegrationForTreeInput! |
Example
Query
mutation BatchCreateAppIntegrationForTree($input: BatchCreateAppIntegrationForTreeInput!) {
batchCreateAppIntegrationForTree(input: $input) {
clientMutationId
errors {
build
error {
...endpointErrorFragment
}
integrationId
}
trees {
_id
ancestorTree {
...TreeFragment
}
app {
...AppFragment
}
appId
configMap
configMapSchema
createdAt
description
etag
globalNodeIds
globalNodes {
...NodeObjectFragment
}
id
locked
name
nodeIds
nodes {
...NodeObjectFragment
}
siblingTrees {
...TreeFragment
}
stash {
...NodeObjectFragment
}
system
tags
templateTree {
...TreeFragment
}
templateTreeId
type
updatedAt
version
versionAlias
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": BatchCreateAppIntegrationForTreeInput}
Response
{
"data": {
"batchCreateAppIntegrationForTree": {
"clientMutationId": 4,
"errors": [BatchCreateAppIntegrationError],
"trees": [Tree]
}
}
}
createTree
Description
A function to create tree.\n
scope
["api:admin", "botbuilder:manage", "tree:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateTreePayload
Arguments
| Name | Description |
|---|---|
input - CreateTreeInput! |
Example
Query
mutation CreateTree($input: CreateTreeInput!) {
createTree(input: $input) {
clientMutationId
tree {
_id
ancestorTree {
...TreeFragment
}
app {
...AppFragment
}
appId
configMap
configMapSchema
createdAt
description
etag
globalNodeIds
globalNodes {
...NodeObjectFragment
}
id
locked
name
nodeIds
nodes {
...NodeObjectFragment
}
siblingTrees {
...TreeFragment
}
stash {
...NodeObjectFragment
}
system
tags
templateTree {
...TreeFragment
}
templateTreeId
type
updatedAt
version
versionAlias
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateTreeInput}
Response
{
"data": {
"createTree": {
"clientMutationId": "4",
"tree": Tree
}
}
}
deleteTree
Description
A function to delete tree.\n
scope
["api:admin", "botbuilder:manage", "tree:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteTreePayload
Arguments
| Name | Description |
|---|---|
input - DeleteTreeInput! |
Example
Query
mutation DeleteTree($input: DeleteTreeInput!) {
deleteTree(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteTreeInput}
Response
{"data": {"deleteTree": {"clientMutationId": 4}}}
duplicateTree
Description
A function to delete tree.\n
scope
["api:admin", "botbuilder:manage", "tree:duplicate"]
rate limit
5 call(s) per app per mintue
Response
Returns a DuplicateTreePayload
Arguments
| Name | Description |
|---|---|
input - DuplicateTreeInput! |
Example
Query
mutation DuplicateTree($input: DuplicateTreeInput!) {
duplicateTree(input: $input) {
clientMutationId
tree {
_id
ancestorTree {
...TreeFragment
}
app {
...AppFragment
}
appId
configMap
configMapSchema
createdAt
description
etag
globalNodeIds
globalNodes {
...NodeObjectFragment
}
id
locked
name
nodeIds
nodes {
...NodeObjectFragment
}
siblingTrees {
...TreeFragment
}
stash {
...NodeObjectFragment
}
system
tags
templateTree {
...TreeFragment
}
templateTreeId
type
updatedAt
version
versionAlias
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DuplicateTreeInput}
Response
{
"data": {
"duplicateTree": {"clientMutationId": 4, "tree": Tree}
}
}
exportTrees
Description
A function to export trees.\n
scope
["api:admin", "tree:export"]
rate limit
5 call(s) per app per mintue
Response
Returns an ExportTreesPayload
Arguments
| Name | Description |
|---|---|
input - ExportTreesInput! |
Example
Query
mutation ExportTrees($input: ExportTreesInput!) {
exportTrees(input: $input) {
actions
conditions
localeGroups
nodes
responses
trees
triggers
url
}
}
Variables
{"input": ExportTreesInput}
Response
{
"data": {
"exportTrees": {
"actions": [{}],
"conditions": [{}],
"localeGroups": [{}],
"nodes": [{}],
"responses": [{}],
"trees": [{}],
"triggers": [{}],
"url": "xyz789"
}
}
}
importTrees
Description
A function to import tree.\n
scope
["api:admin", "botbuilder:manage", "tree:create", "node:create", "trigger:create", "condition:create", "action:create", "response:create", "localeGroup:create"]
Input params scope
"trees"
scope: ["api:admin", "botbuilder:manage", "tree:create"]
"nodes"
scope: ["api:admin", "botbuilder:manage", "node:create"]
"triggers"
scope: ["api:admin", "botbuilder:manage", "trigger:create"]
"conditions"
scope: ["api:admin", "botbuilder:manage", "condition:create"]
"actions"
scope: ["api:admin", "botbuilder:manage", "action:create"]
"responses"
scope: ["api:admin", "botbuilder:manage", "response:create"]
"localeGroups"
scope: ["api:admin", "botbuilder:manage", "localeGroup:create"]
rate limit
5 call(s) per app per mintue
Response
Returns an ImportTreesPayload
Arguments
| Name | Description |
|---|---|
input - ImportTreesInput! |
Example
Query
mutation ImportTrees($input: ImportTreesInput!) {
importTrees(input: $input) {
trees {
_id
ancestorTree {
...TreeFragment
}
app {
...AppFragment
}
appId
configMap
configMapSchema
createdAt
description
etag
globalNodeIds
globalNodes {
...NodeObjectFragment
}
id
locked
name
nodeIds
nodes {
...NodeObjectFragment
}
siblingTrees {
...TreeFragment
}
stash {
...NodeObjectFragment
}
system
tags
templateTree {
...TreeFragment
}
templateTreeId
type
updatedAt
version
versionAlias
workspace {
...WorkspaceFragment
}
}
uninstalledIntegrations {
build
icon
integrationId
integrationName
isPlatform
private
version
}
}
}
Variables
{"input": ImportTreesInput}
Response
{
"data": {
"importTrees": {
"trees": [Tree],
"uninstalledIntegrations": [UninstalledIntegration]
}
}
}
updateTree
Description
A function to update tree.\n
scope
["api:admin", "botbuilder:manage", "tree:updateBasicInfo", "tree:updateNodes", "tree:updateTreeSetting"]
Input params scope
"name"
scope: ["api:admin", "tree:updateBasicInfo", "botbuilder:manage"]
"description"
scope: ["api:admin", "tree:updateBasicInfo", "botbuilder:manage"]
"globalNodes"
scope: ["api:admin", "tree:updateNodes", "botbuilder:manage"]
"nodes"
scope: ["api:admin", "tree:updateNodes", "botbuilder:manage"]
"configMapSchema"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"configMap"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"type"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"templateTreeId"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"versionAlias"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"tags"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"system"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
rate limit
10 call(s) per app per mintue
Response
Returns an UpdateTreePayload
Arguments
| Name | Description |
|---|---|
input - UpdateTreeInput! |
Example
Query
mutation UpdateTree($input: UpdateTreeInput!) {
updateTree(input: $input) {
clientMutationId
tree {
_id
ancestorTree {
...TreeFragment
}
app {
...AppFragment
}
appId
configMap
configMapSchema
createdAt
description
etag
globalNodeIds
globalNodes {
...NodeObjectFragment
}
id
locked
name
nodeIds
nodes {
...NodeObjectFragment
}
siblingTrees {
...TreeFragment
}
stash {
...NodeObjectFragment
}
system
tags
templateTree {
...TreeFragment
}
templateTreeId
type
updatedAt
version
versionAlias
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateTreeInput}
Response
{
"data": {
"updateTree": {"clientMutationId": 4, "tree": Tree}
}
}
Action
createAction
Description
A function to create action.
scope
["api:admin", "botbuilder:manage", "condition:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateActionPayload
Arguments
| Name | Description |
|---|---|
input - CreateActionInput! |
Example
Query
mutation CreateAction($input: CreateActionInput!) {
createAction(input: $input) {
action {
_id
app {
...AppFragment
}
createdAt
description
etag
functionString
history
id
name
tags
updatedAt
}
clientMutationId
}
}
Variables
{"input": CreateActionInput}
Response
{
"data": {
"createAction": {
"action": Action,
"clientMutationId": "4"
}
}
}
deleteAction
Description
A function to delete action.\n
scope
["api:admin", "botbuilder:manage", "condition:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteActionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteActionInput! |
Example
Query
mutation DeleteAction($input: DeleteActionInput!) {
deleteAction(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteActionInput}
Response
{
"data": {
"deleteAction": {
"clientMutationId": "4"
}
}
}
updateAction
Description
A function to update action.\n
scope
["api:admin", "botbuilder:manage", "condition:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateActionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateActionInput! |
Example
Query
mutation UpdateAction($input: UpdateActionInput!) {
updateAction(input: $input) {
action {
_id
app {
...AppFragment
}
createdAt
description
etag
functionString
history
id
name
tags
updatedAt
}
clientMutationId
}
}
Variables
{"input": UpdateActionInput}
Response
{
"data": {
"updateAction": {
"action": Action,
"clientMutationId": 4
}
}
}
Node
createNode
Description
A function to create node.\n
scope
["api:admin", "node:create"]
rate limit
5 call(s) per app per mintue
Response
Returns a CreateNodePayload
Arguments
| Name | Description |
|---|---|
input - CreateNodeInput! |
Example
Query
mutation CreateNode($input: CreateNodeInput!) {
createNode(input: $input) {
clientMutationId
node {
_id
actionIds
actions {
...ActionFragment
}
analytics {
...AnalyticsFragment
}
app {
...AppFragment
}
appId
colour
compositeId
createdAt
description
dialogflow {
...DialogflowSettingsFragment
}
etag
global
history
id
locked
luis {
...LuisSettingsFragment
}
memberTagging {
...MemberTaggingFragment
}
name
path
postActionIds
postActions {
...ActionFragment
}
preActionIds
preActions {
...ActionFragment
}
priority
redirect {
...RedirectFragment
}
responseIds
responses {
...ResponseFragment
}
saveCompositeId
tags
templateTreeId
tree {
...TreeFragment
}
treeId
trigger {
...TriggerFragment
}
triggerId
type
updatedAt
}
}
}
Variables
{"input": CreateNodeInput}
Response
{
"data": {
"createNode": {
"clientMutationId": 4,
"node": NodeObject
}
}
}
deleteNode
Description
A function to delete node.\n
scope
["api:admin", "node:delete"]
rate limit
5 call(s) per app per mintue
Response
Returns a DeleteNodePayload
Arguments
| Name | Description |
|---|---|
input - DeleteNodeInput! |
Example
Query
mutation DeleteNode($input: DeleteNodeInput!) {
deleteNode(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteNodeInput}
Response
{
"data": {
"deleteNode": {
"clientMutationId": "abc123"
}
}
}
updateNode
Description
A function to update node.\n
scope
["api:admin", "node:update"]
rate limit
5 call(s) per app per mintue
Response
Returns an UpdateNodePayload
Arguments
| Name | Description |
|---|---|
input - UpdateNodeInput! |
Example
Query
mutation UpdateNode($input: UpdateNodeInput!) {
updateNode(input: $input) {
clientMutationId
node {
_id
actionIds
actions {
...ActionFragment
}
analytics {
...AnalyticsFragment
}
app {
...AppFragment
}
appId
colour
compositeId
createdAt
description
dialogflow {
...DialogflowSettingsFragment
}
etag
global
history
id
locked
luis {
...LuisSettingsFragment
}
memberTagging {
...MemberTaggingFragment
}
name
path
postActionIds
postActions {
...ActionFragment
}
preActionIds
preActions {
...ActionFragment
}
priority
redirect {
...RedirectFragment
}
responseIds
responses {
...ResponseFragment
}
saveCompositeId
tags
templateTreeId
tree {
...TreeFragment
}
treeId
trigger {
...TriggerFragment
}
triggerId
type
updatedAt
}
}
}
Variables
{"input": UpdateNodeInput}
Response
{
"data": {
"updateNode": {
"clientMutationId": 4,
"node": NodeObject
}
}
}
Types
Action
Example
{
"_id": "4",
"app": App,
"createdAt": {},
"description": "xyz789",
"etag": 4,
"functionString": "abc123",
"history": [{}],
"id": "4",
"name": "abc123",
"tags": ["abc123"],
"updatedAt": {}
}
ActionConnection
Fields
| Field Name | Description |
|---|---|
edges - [ActionEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ActionEdge],
"pageInfo": PageInfo
}
ActionEdge
ActiveMemberCounter
ActiveMemberCounterConnection
Fields
| Field Name | Description |
|---|---|
data - [ActiveMemberCounter] | |
pageInfo - PageInfo | |
total_no_of_comment_member - Long | |
total_no_of_member - Long |
Example
{
"data": [ActiveMemberCounter],
"pageInfo": PageInfo,
"total_no_of_comment_member": {},
"total_no_of_member": {}
}
AddNoteToMemberInput
Fields
| Input Field | Description |
|---|---|
clientMutationId - ID | |
memberId - ID! | |
note - NoteInput! |
Example
{
"clientMutationId": "4",
"memberId": "4",
"note": NoteInput
}
AddNoteToMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
member - Member |
Example
{
"clientMutationId": "4",
"error": GenericError,
"member": Member
}
AddOutletInPairInput
AddOutletInPairPayload
AddToSetKeyInput
Address
AddressInput
Fields
| Input Field | Description |
|---|---|
action - String | UPDATE\n Update Profile Data using alias\n Replace\n Overwrite the entire Profile Data using alias\n DELETE\n Remove any non-default Profile Data using alias\n |
alias - String | |
city - String | |
country - String | |
line1 - String | |
line2 - String | |
state - String | |
zip - String |
Example
{
"action": "xyz789",
"alias": "xyz789",
"city": "abc123",
"country": "abc123",
"line1": "xyz789",
"line2": "xyz789",
"state": "xyz789",
"zip": "abc123"
}
Admin
Example
{
"_id": 4,
"active": false,
"app": App,
"channel": Channel,
"createdAt": {},
"etag": "4",
"externalId": 4,
"firstName": "abc123",
"gender": "xyz789",
"id": 4,
"lastName": "xyz789",
"locale": "xyz789",
"meta": {},
"name": "xyz789",
"profilePic": "xyz789",
"tags": ["xyz789"],
"updatedAt": {}
}
AdminConnection
Fields
| Field Name | Description |
|---|---|
edges - [AdminEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [AdminEdge],
"pageInfo": PageInfo
}
AdminEdge
Agenda
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
app - App! | |
appId - ID | |
channel - Channel | |
channelId - ID | |
completed - Boolean | |
createdAt - Long! | |
etag - ID | |
id - ID! | |
lastRunAt - Long | |
member - Member | |
memberId - ID | |
meta - JSON | |
nextRunAt - Long | |
node - NodeObject | |
nodeCompositeId - ID | |
pattern - String | |
priority - Int | |
responses - JSON | |
runUntil - Long | |
subscriptionPush - AgendaSubscriptionPushConfig | |
tag - String | |
tree - Tree | |
treeId - ID | |
type - String | |
updatedAt - Long |
Example
{
"_id": "4",
"app": App,
"appId": "4",
"channel": Channel,
"channelId": 4,
"completed": true,
"createdAt": {},
"etag": 4,
"id": "4",
"lastRunAt": {},
"member": Member,
"memberId": 4,
"meta": {},
"nextRunAt": {},
"node": NodeObject,
"nodeCompositeId": "4",
"pattern": "abc123",
"priority": 123,
"responses": {},
"runUntil": {},
"subscriptionPush": AgendaSubscriptionPushConfig,
"tag": "xyz789",
"tree": Tree,
"treeId": 4,
"type": "abc123",
"updatedAt": {}
}
AgendaSubscriptionPushConfig
AgendaSubscriptionPushConfigInput
AggregateDataSourceDocsInput
Description
Input type for aggregating datasource docs.
Example
{"clientMutationId": 4, "collectionName": 4, "options": {}, "pipeline": {}}
AggregateDataSourceDocsPayload
Analytics
AnalyticsCustomEventCounterConnectionRD
Fields
| Field Name | Description |
|---|---|
edges - [AnalyticsCustomEventCounterEdgeRD] | |
pageInfo - PageInfo | |
total_no_of_analytics - Long! |
Example
{
"edges": [AnalyticsCustomEventCounterEdgeRD],
"pageInfo": PageInfo,
"total_no_of_analytics": {}
}
AnalyticsCustomEventCounterConnectionTB
Fields
| Field Name | Description |
|---|---|
edges - [AnalyticsCustomEventCounterEdgeTB] | |
pageInfo - PageInfo | |
total_no_of_analytics - Long! |
Example
{
"edges": [AnalyticsCustomEventCounterEdgeTB],
"pageInfo": PageInfo,
"total_no_of_analytics": {}
}
AnalyticsCustomEventCounterEdgeRD
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - AnalyticsCustomEventCounterRD |
Example
{"cursor": 4, "node": AnalyticsCustomEventCounterRD}
AnalyticsCustomEventCounterEdgeTB
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - AnalyticsCustomEventCounterTB |
Example
{"cursor": 4, "node": AnalyticsCustomEventCounterTB}
AnalyticsCustomEventCounterRD
Example
{
"action": "abc123",
"app": App,
"appId": 4,
"category": "abc123",
"label": "xyz789",
"member": "abc123",
"no_of_analytics": {},
"no_of_unique_member_analytics": {}
}
AnalyticsCustomEventCounterTB
Example
{
"action": "abc123",
"app": App,
"appId": "4",
"bucket": {},
"category": "abc123",
"channel": Channel,
"channelId": "4",
"label": "xyz789",
"no_of_analytics": {}
}
AnalyticsInput
ApiScope
Fields
| Field Name | Description |
|---|---|
_id - ID! | scope ["api:admin"] 5 call(s) per app per mintue |
actions - ActionConnection | A function used to get actions list.\n ["api:admin", "action:read"] 5 call(s) per app per mintue |
Arguments
| |
activeMemberCounter - ActiveMemberCounterConnection | A function used to get active member count.\n ["api:admin", "dashboard:listUsers"] 5 call(s) per app per mintue |
Arguments
| |
admins - AdminConnection | A function to search for a collection of admins. Can also be used with varies filters.\n Currently deprecated.\n ["api:admin", "dashboard:listTicketing"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
analyticsCustomEventOverviewDateHistogram - AnalyticsCustomEventCounterConnectionTB | A function used to get the Overview Date Histogram of an Analytics Custom Event.\n Can not query for member or no_of_unique_member_analytics.\n ["api:admin", "dashboard:listAnalytics"] 5 call(s) per app per mintue |
Arguments
| |
analyticsCustomEventOverviewTable - AnalyticsCustomEventCounterConnectionRD | A function used to get the Overview Table of an Analytics Custom Event.\n Either member or no_of_unique_member_analytics must be in the query fields.\n ["api:admin", "dashboard:listAnalytics"] 5 call(s) per app per mintue |
Arguments
| |
app - App | A function to get app info\n ["api:admin", "appInfo:get", "appSettings:get", "dataSource:listDatasources", "billing:getSubscription", "teamMember:list"] 20 call(s) per app per mintue |
Arguments
| |
assignment - Assignment | A function to get an assignment using the assignmentId.\n Currently deprecated.\n ["api:admin", "dashboard:listAssignment"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
assignments - AssignmentConnection | A function to get a collection of assignments. Can also be used with varies filters.\n Currently deprecated.\n ["api:admin", "dashboard:listAssignment"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
audiences - AudienceConnection | A function used to get audience list.\n ["api:admin", "audience:read"] 5 call(s) per app per mintue |
Arguments
| |
backgroundTask - BackgroundTask | To get info of a background task, typically used to check the status of the background task.\n ["backgroundTask:get", "api:admin"] 12 call(s) per app per mintue |
Arguments
| |
channel - Channel | A function to get channel detail.\n ["api:admin", "channel:getAvailabilities", "channel:getBasicInfo", "channel:getBroadcastGroupSettings", "channel:getLiveChatSettings", "channel:getPlatformInfo", "channel:getPlatformSettings", "channel:getTreeSettings"] 30 call(s) per app per mintue |
Arguments
| |
channels - ChannelConnection | A function to get channels.\n ["api:admin", "channel:list"] 30 call(s) per app per mintue |
Arguments
| |
chat - Chat | A function used to get chat from either chatId or messageId.\n ["conversation:read", "member:getConversation", "api:admin"] 60 call(s) per app per mintue |
conditions - ConditionConnection | A function used to get condition list.\n Currently deprecated.\n ["api:admin", "condition:read"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
conversationHistory - ChatConnection | A function to get chat history. Can also be used with varies filters.\n ["conversation:read", "member:getConversation", "api:admin"] 30 call(s) per app per mintue |
Arguments
| |
dailyActiveMemberOverview - DailyActiveMemberOverviewPayload | A function used to get Daily Active member.\n ["api:admin", "dashboard:listUsers"] 5 call(s) per app per mintue |
Arguments
| |
distinctDataSourceData - JSON | A function to search distinct datasource doc.\n ["api:admin", "dataSource:listDocs"] 5 call(s) per app per mintue |
fetchDataSourceData - JSON | A function to search datasource doc.\n ["api:admin", "dataSource:listDocs"] 10 call(s) per app per mintue |
Arguments
| |
fetchGeoNearDataSourceData - JSON | A function to search datasource doc based on location.\n ["api:admin", "dataSource:listDocs"] 5 call(s) per app per mintue |
Arguments
| |
file - RetrieveFilePayload | A function used to get file from fileId.\n ["api:admin", "file:admin", "file:get", "medialibrary:get"] 60 call(s) per app per mintue |
Arguments
| |
files - FileConnection | A function used to get a paginated list of files.\n ["mediaLibrary:list", "api:admin"] 60 call(s) per app per mintue |
Arguments
| |
groups - GroupConnection | A function to get a collection of groups. Can also be used with varies filters.\n Currently deprecated.\n ["api:admin", "dashboard:listAssignment"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
id - ID! | scope ["api:admin"] 5 call(s) per app per mintue |
installedIntegration - AppIntegration | Get an installed integration using integrationId and build or appIntegrationId ["api:admin", "appIntegration:get"] 5 call(s) per app per mintue |
installedIntegrations - [AppIntegration] | Get list of installed integrations ["api:admin", "appIntegration:get"] 5 call(s) per app per mintue |
Arguments
| |
integrations - JSON | A function to get the integrations of an app. Only gives integrations for app that matches the user's.\n Currently deprecated.\n ["api:admin", "integration:list"] 5 call(s) per app per mintue No longer supported |
localeGroups - LocaleGroupConnection | A function used to get locale group list.\n ["api:admin", "localeGroup:read"] 5 call(s) per app per mintue |
Arguments
| |
member - Member | A function to search for a memeber. Can be used to get a single member using memberID or externalID.\n ["conversation:read", "api:admin", "member:getDetails"] 600 call(s) per app per mintue |
memberRaw - JSON | A function to search for a member. Currently deprecated.\n ["api:admin", "member:getDetails"] 5 call(s) per app per mintue Use ApiScope.member |
members - MemberConnection | A function to search for a collection of members. Can also be used with varies filters.\n ["api:admin", "member:getDetails"] 30 call(s) per app per mintue |
Arguments
| |
newMemberCounter - NewMemberCounterConnection | A function used to get new member count.\n ["api:admin", "dashboard:listUsers"] 5 call(s) per app per mintue |
Arguments
| |
nlpAnalyticsOverview - NLPAnalyticsCounterConnection | A function to get NLP Analytics Overview. Either integrationId or channelId must be used.\n ["api:admin", "dashboard:listNlpAnalytics"] 5 call(s) per app per mintue |
Arguments
| |
nodes - NodeObjectConnection | A function used to get node list.\n ["api:admin", "node:read"] 5 call(s) per app per mintue |
Arguments
| |
postCommentAnalyticsOverview - PostCommentAnalyticsOverviewConnection | A function to get Comment Analytics Overview. Can also be used with varies filters.\n Currently deprecated.\n ["api:admin", "dashboard:listCommentReply"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
priorityGroups - PriorityGroupConnection | A function used to get priority group list.\n ["api:admin", "priorityGroup:list"] 5 call(s) per app per mintue |
Arguments
| |
responses - ResponseConnection | A function used to get response list.\n ["api:admin", "response:read"] 5 call(s) per app per mintue |
Arguments
| |
subscriptionPushes - SubscriptionPushConnection | A function used to get subscription push list.\n ["api:admin", "push:list"] 5 call(s) per app per mintue |
Arguments
| |
ticket - Ticket | scope ["ticket:get"] 60 call(s) per app per mintue |
Arguments
| |
tickets - TicketDataConnection | scope ["ticket:list"] 60 call(s) per app per mintue |
tree - Tree | A function to get tree info.\n ["api:admin", "botbuilder:read", "tree:getBasicInfo", "tree:getDetails", "tree:getNodes", "tree:getTreeSetting", "appInfo:get", "appSettings:get"] 5 call(s) per app per mintue |
Arguments
| |
trees - TreeConnection | A function used to get tree list.\n ["api:admin", "tree:read", "tree:list"] 5 call(s) per app per mintue |
Arguments
| |
triggers - TriggerConnection | A function used to get trigger list.\n ["api:admin", "trigger:read"] 5 call(s) per app per mintue |
Arguments
| |
userContext - JSON | A function to get token info 5 call(s) per app per mintue |
Arguments
| |
whatsAppFile - WhatsAppFileUrl | A function to get the URL of a file in WhatsApp. Both mediaId and channelId must be present.\n Currently deprecated.\n ["api:admin", "whatsapp:getFile"] 60 call(s) per app per mintue No longer supported |
whatsAppTemplate - WhatsAppMessageTemplateConnection | A function to get a collection of WhatsApp template. Either integrationId or channelId must be used.\n Currently deprecated.\n ["api:admin", "whatsappMessageTemplates:list"] 5 call(s) per app per mintue No longer supported |
Arguments
| |
Example
{
"_id": 4,
"actions": ActionConnection,
"activeMemberCounter": ActiveMemberCounterConnection,
"admins": AdminConnection,
"analyticsCustomEventOverviewDateHistogram": AnalyticsCustomEventCounterConnectionTB,
"analyticsCustomEventOverviewTable": AnalyticsCustomEventCounterConnectionRD,
"app": App,
"assignment": Assignment,
"assignments": AssignmentConnection,
"audiences": AudienceConnection,
"backgroundTask": BackgroundTask,
"channel": Channel,
"channels": ChannelConnection,
"chat": Chat,
"conditions": ConditionConnection,
"conversationHistory": ChatConnection,
"dailyActiveMemberOverview": DailyActiveMemberOverviewPayload,
"distinctDataSourceData": {},
"fetchDataSourceData": {},
"fetchGeoNearDataSourceData": {},
"file": RetrieveFilePayload,
"files": FileConnection,
"groups": GroupConnection,
"id": "4",
"installedIntegration": AppIntegration,
"installedIntegrations": [AppIntegration],
"integrations": {},
"localeGroups": LocaleGroupConnection,
"member": Member,
"memberRaw": {},
"members": MemberConnection,
"newMemberCounter": NewMemberCounterConnection,
"nlpAnalyticsOverview": NLPAnalyticsCounterConnection,
"nodes": NodeObjectConnection,
"postCommentAnalyticsOverview": PostCommentAnalyticsOverviewConnection,
"priorityGroups": PriorityGroupConnection,
"responses": ResponseConnection,
"subscriptionPushes": SubscriptionPushConnection,
"ticket": Ticket,
"tickets": TicketDataConnection,
"tree": Tree,
"trees": TreeConnection,
"triggers": TriggerConnection,
"userContext": {},
"whatsAppFile": WhatsAppFileUrl,
"whatsAppTemplate": WhatsAppMessageTemplateConnection
}
App
Fields
| Field Name | Description |
|---|---|
_id - ID! | scope ["api:admin", "appInfo:get"] |
activated - Boolean | scope ["api:admin", "appInfo:get"] |
createdAt - Long! | scope ["api:admin", "appInfo:get"] |
dataSource - DataSource | scope ["api:admin", "dataSource:listDatasources"] |
Arguments
| |
dataSources - [DataSource] | scope ["api:admin", "dataSource:listDatasources"] |
description - String | scope ["api:admin", "appInfo:get"] |
etag - ID | scope ["api:admin", "appInfo:get"] |
id - ID! | scope ["api:admin", "appInfo:get"] |
inlets - [Channel] | scope ["api:admin", "appSettings:get"] |
integrations - [JSON] | scope ["api:admin", "appSettings:get"] |
managedBy - Partner | scope ["api:admin", "appInfo:get"] |
managementType - String | scope ["api:admin", "appSettings:get"] |
meta - JSON | scope ["api:admin", "appSettings:get"] |
name - String! | scope ["api:admin", "appInfo:get"] |
outlets - [Channel] | scope ["api:admin", "appSettings:get"] |
pairs - [Pair] | scope ["api:admin", "appSettings:get"] |
teamMembers - [TeamMember] | scope ["api:admin", "appSettings:get", "teamMember:list"] |
updatedAt - Long | scope ["api:admin", "appInfo:get"] |
Example
{
"_id": 4,
"activated": true,
"createdAt": {},
"dataSource": DataSource,
"dataSources": [DataSource],
"description": "abc123",
"etag": "4",
"id": "4",
"inlets": [Channel],
"integrations": [{}],
"managedBy": Partner,
"managementType": "xyz789",
"meta": {},
"name": "abc123",
"outlets": [Channel],
"pairs": [Pair],
"teamMembers": [TeamMember],
"updatedAt": {}
}
AppIntegration
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
alias - String! | |
app - App! | |
appId - ID | |
author - Author | |
authorId - ID | |
build - Int | |
builderSidebarView - IntegrationView | |
changelog - String | |
channel - Channel | |
createdAt - Long! | |
customView - IntegrationView | |
dashboardView - IntegrationView | |
defaultResourceTemplate - ResourceTemplate | |
Arguments
| |
description - String | |
endpoints - IntegrationEndpoints | |
etag - ID | |
features - [String] | |
functionString - String | |
hooks - Hook | |
icon - String | |
id - ID! | |
inbox - InboxIntegration | |
integrationDescription - String | |
integrationId - ID | |
integrationKey - String | |
integrationName - String | |
integration_id - ID | |
isLatestPublished - Boolean | |
latestPublished - Int | |
meta - JSON | |
platformSettingsView - String | |
privacyPolicyUrl - String | |
readme - String | |
resourceTemplates - [ResourceTemplate] | |
Arguments
| |
scopes - [String] | |
secret - String | |
settingsSchema - JSON | |
settingsValidatorFunctionString - String | |
settingsView - String | |
signature - String | |
supportEmail - String | |
supportTicketing - Boolean | |
supportedMediaTypes - SupportedMediaTypes | |
termsAndConditionsUrl - String | |
trees - [IntegrationTree] | |
updatedAt - Long | |
version - String | |
websiteUrl - String | |
Example
{
"_id": "4",
"alias": "abc123",
"app": App,
"appId": "4",
"author": Author,
"authorId": "4",
"build": 123,
"builderSidebarView": IntegrationView,
"changelog": "abc123",
"channel": Channel,
"createdAt": {},
"customView": IntegrationView,
"dashboardView": IntegrationView,
"defaultResourceTemplate": ResourceTemplate,
"description": "xyz789",
"endpoints": IntegrationEndpoints,
"etag": 4,
"features": ["xyz789"],
"functionString": "abc123",
"hooks": Hook,
"icon": "xyz789",
"id": 4,
"inbox": InboxIntegration,
"integrationDescription": "abc123",
"integrationId": 4,
"integrationKey": "xyz789",
"integrationName": "abc123",
"integration_id": "4",
"isLatestPublished": false,
"latestPublished": 987,
"meta": {},
"platformSettingsView": "xyz789",
"privacyPolicyUrl": "abc123",
"readme": "xyz789",
"resourceTemplates": [ResourceTemplate],
"scopes": ["xyz789"],
"secret": "abc123",
"settingsSchema": {},
"settingsValidatorFunctionString": "abc123",
"settingsView": "xyz789",
"signature": "xyz789",
"supportEmail": "abc123",
"supportTicketing": false,
"supportedMediaTypes": SupportedMediaTypes,
"termsAndConditionsUrl": "xyz789",
"trees": [IntegrationTree],
"updatedAt": {},
"version": "xyz789",
"websiteUrl": "xyz789"
}
Assignment
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
active - Boolean | |
adminContactMessage - JSON | |
app - App! | |
appId - ID | |
assignedAt - Long | |
assignee - Admin | |
assigner - Admin | |
createdAt - Long! | |
etag - ID | |
expiry - Long | |
group - Group | |
groupExternalId - ID | |
groupId - ID | |
groupInfo - JSON | |
history - Boolean | |
id - ID! | |
inactivatedAt - Long | |
inlet - Channel | |
inletGroup - Boolean | |
inletGroupExternalId - ID | |
inletGroupInfo - JSON | |
inletId - ID | |
inletMessage - JSON | |
isZendesk - Boolean | |
label - String | |
member - Member | |
memberId - ID | |
meta - JSON | |
noGroupCreation - Boolean | |
parentAssignment - Assignment | |
parentAssignmentId - ID | |
previousAssignment - Assignment | |
previousAssignmentId - ID | |
reassign - Boolean | |
reassignRelayMessage - JSON | |
redirectMemberToNode - Redirect | |
relayMessage - JSON | |
status - String | |
tags - [String] | |
takenMessage - String | |
targets - [AssignmentTarget] | |
updatedAt - Long |
Example
{
"_id": "4",
"active": true,
"adminContactMessage": {},
"app": App,
"appId": 4,
"assignedAt": {},
"assignee": Admin,
"assigner": Admin,
"createdAt": {},
"etag": 4,
"expiry": {},
"group": Group,
"groupExternalId": 4,
"groupId": 4,
"groupInfo": {},
"history": false,
"id": "4",
"inactivatedAt": {},
"inlet": Channel,
"inletGroup": false,
"inletGroupExternalId": "4",
"inletGroupInfo": {},
"inletId": 4,
"inletMessage": {},
"isZendesk": false,
"label": "xyz789",
"member": Member,
"memberId": 4,
"meta": {},
"noGroupCreation": true,
"parentAssignment": Assignment,
"parentAssignmentId": 4,
"previousAssignment": Assignment,
"previousAssignmentId": 4,
"reassign": true,
"reassignRelayMessage": {},
"redirectMemberToNode": Redirect,
"relayMessage": {},
"status": "abc123",
"tags": ["abc123"],
"takenMessage": "xyz789",
"targets": [AssignmentTarget],
"updatedAt": {}
}
AssignmentConnection
Fields
| Field Name | Description |
|---|---|
edges - [AssignmentEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [AssignmentEdge],
"pageInfo": PageInfo
}
AssignmentEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - Assignment |
Example
{"cursor": 4, "node": Assignment}
AssignmentTarget
Fields
| Field Name | Description |
|---|---|
admin - Admin | |
broadcastGroups - [BroadcastGroup] | |
channel - Channel | |
channelId - ID | |
label - String |
Example
{
"admin": Admin,
"broadcastGroups": [BroadcastGroup],
"channel": Channel,
"channelId": "4",
"label": "xyz789"
}
AttachmentUploadInput
AttachmentUploadPayload
Audience
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
app - App! | |
channel - Channel | |
channelId - ID | |
createdAt - Long! | |
description - String | |
etag - ID | |
filter - AudienceFilter | |
id - ID! | |
memberIds - [ID] | |
Arguments
| |
members - MemberConnection | |
name - String | |
source - String | |
static - Boolean | |
tags - [String] | |
updatedAt - Long | |
Example
{
"_id": "4",
"app": App,
"channel": Channel,
"channelId": 4,
"createdAt": {},
"description": "abc123",
"etag": 4,
"filter": AudienceFilter,
"id": 4,
"memberIds": ["4"],
"members": MemberConnection,
"name": "xyz789",
"source": "abc123",
"static": true,
"tags": ["xyz789"],
"updatedAt": {}
}
AudienceConnection
Fields
| Field Name | Description |
|---|---|
edges - [AudienceEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [AudienceEdge],
"pageInfo": PageInfo
}
AudienceEdge
AudienceFilter
Fields
| Field Name | Description |
|---|---|
criteria - JSON | |
criteriaFbOTNTags - [String] | |
criteriaMemberIds - [ID] | |
Arguments
| |
minusMemberIds - [ID] | |
minusMembers - [Member] | |
plusMemberIds - [ID] | |
plusMembers - [Member] | |
specificMemberIds - [ID] | |
Arguments
| |
specificMembers - [Member] | |
specificMembersOnly - Boolean | |
Example
{
"criteria": {},
"criteriaFbOTNTags": ["abc123"],
"criteriaMemberIds": [4],
"minusMemberIds": [4],
"minusMembers": [Member],
"plusMemberIds": ["4"],
"plusMembers": [Member],
"specificMemberIds": [4],
"specificMembers": [Member],
"specificMembersOnly": false
}
AudienceFilterInput
Fields
| Input Field | Description |
|---|---|
criteria - JSON | Criteria is an array of object that is translated to a member filter.\n Small Example: [{\n "field" : "externalId",\n "operator" : "equal",\n "value" : "123"\n },{\n "field" : "channel",\n "operator" : "equal",\n "value" : "abc"\n }]\n "criteria options": \n 1.\n "field": "_id" | "tags" | "fbOTNTag",\n "filters": [{ "operator": "in" | "nin", "value": ["ID | String"]}]\n 2.\n "field": "createdAt" | "updatedAt",\n "from": "epoch number",\n "to": "epoch number"\n 3.\n "field": "firstName" | "lastName",\n "value": "String"\n 4.\n "field": "liveChat",\n "value": "Boolean"\n 5.\n "operator": "equal" | "in" | "nin" | "ne" | "regex" ("eq" does not work)\n "field": "String", (as long as field is not one of the aboves, example: "externalId", "channel", "locale", "gender", "botMeta.tempData.abc", "meta.def")\n "value": "Any" |
minusMembers - [ID] | |
plusMembers - [ID] | |
specificMembers - [ID] | |
specificMembersOnly - Boolean |
Example
{
"criteria": {},
"minusMembers": [4],
"plusMembers": ["4"],
"specificMembers": [4],
"specificMembersOnly": true
}
Author
Fields
| Field Name | Description |
|---|---|
email - String |
Example
{"email": "abc123"}
BackgroundTask
Example
{
"_id": "4",
"app": App,
"appId": 4,
"createdAt": {},
"data": {},
"endAt": {},
"etag": "4",
"id": 4,
"message": "xyz789",
"meta": {},
"runAt": {},
"status": "xyz789",
"type": "abc123",
"updatedAt": {}
}
BatchCreateAppIntegrationError
Fields
| Field Name | Description |
|---|---|
build - Int | |
error - endpointError | |
integrationId - String |
Example
{
"build": 123,
"error": endpointError,
"integrationId": "abc123"
}
BatchCreateAppIntegrationForTreeInput
Fields
| Input Field | Description |
|---|---|
actions - [JSON] | |
app - ID | |
clientMutationId - ID | |
conditions - [JSON] | |
forceKeepResponsePlatforms - [String] | List of Platforms to keep the response. Ex: ["facebook", "whatsapp-cloud"] |
localeGroups - [JSON] | |
nodes - [JSON] | |
normalIntegrations - [NormalIntegrationInput] | |
platformIntegrations - [PlatformIntegrationInput] | |
prefix - String | |
responses - [JSON] | |
trees - [JSON] | |
triggers - [JSON] | |
url - String |
Example
{
"actions": [{}],
"app": 4,
"clientMutationId": "4",
"conditions": [{}],
"forceKeepResponsePlatforms": ["abc123"],
"localeGroups": [{}],
"nodes": [{}],
"normalIntegrations": [NormalIntegrationInput],
"platformIntegrations": [PlatformIntegrationInput],
"prefix": "abc123",
"responses": [{}],
"trees": [{}],
"triggers": [{}],
"url": "xyz789"
}
BatchCreateAppIntegrationForTreePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
errors - [BatchCreateAppIntegrationError] | |
trees - [Tree] |
Example
{
"clientMutationId": 4,
"errors": [BatchCreateAppIntegrationError],
"trees": [Tree]
}
BatchCreateChatInput
Fields
| Input Field | Description |
|---|---|
chats - [ChatInput] | Array of chat object |
clientMutationId - ID | ID generated by relay client for tracking the progress |
sendOutbound - Boolean |
Example
{
"chats": [ChatInput],
"clientMutationId": 4,
"sendOutbound": true
}
BatchCreateChatPayload
BatchUpdateMemberInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channel - ID | Channel ID (required when using externalIds) |
clientMutationId - ID | |
externalIds - [ID] | Member external Ids (Either memberIds or externalIds) |
gender - String | Member gender |
locale - String | Member locale |
memberIds - [ID] | Member Ids (Either memberIds or externalIds) |
option - MongoDBArrayOption | Tags manipulation option |
tags - [String] | Member tags |
Example
{
"app": "4",
"channel": "4",
"clientMutationId": 4,
"externalIds": ["4"],
"gender": "abc123",
"locale": "xyz789",
"memberIds": [4],
"option": "addToSet",
"tags": ["xyz789"]
}
BatchUpdateMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BotMeta
BotMetaInput
BroadcastGroup
Channel
Fields
| Field Name | Description |
|---|---|
_id - ID! | scope ["api:admin", "channel:getBasicInfo"] |
app - App! | scope ["api:admin", "channel:getDetails"] |
appId - ID | scope ["api:admin", "channel:getDetails"] |
appIntegrationAccessToken - ID | scope ["api:admin", "channel:getBasicInfo"] |
Arguments
| |
archived - Boolean | scope ["api:admin", "channel:getBasicInfo"] |
archivedAt - Long | scope ["api:admin", "channel:getBasicInfo"] |
availability - JSON | scope ["api:admin", "channel:getAvailabilities"] No longer supported |
broadcastGroups - [ChannelBroadcastGroup] | scope ["api:admin", "channel:getBroadcastGroupSettings"] No longer supported |
channelSecret - String | scope ["api:admin", "channel:getDetails"] |
connected - Boolean | scope ["api:admin", "channel:getBasicInfo"] |
createdAt - Long! | scope ["api:admin", "channel:getBasicInfo"] |
description - String | scope ["api:admin", "channel:getBasicInfo"] |
environment - ChannelEnvironment | scope ["api:admin", "channel:getEnvironmentInfo"] |
Arguments
| |
environments - [ChannelEnvironment] | scope ["api:admin", "channel:getEnvironmentInfo"] |
etag - ID | scope ["api:admin", "channel:getBasicInfo"] |
exclusiveLiveChat - Boolean | scope ["api:admin", "channel:getBasicInfo"] No longer supported |
globalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] No longer supported |
id - ID! | scope ["api:admin", "channel:getBasicInfo"] |
incomingWebhooks - [ChannelIncomingWebhook] | scope ["api:admin", "channel:getDetails"] |
info - JSON | scope ["api:admin", "channel:getPlatformInfo"] No longer supported |
inletGroup - Boolean | scope ["api:admin", "channel:getBroadcastGroupSettings"] No longer supported |
liveChatAgendaObjects - [LiveChatAgenda] | scope ["api:admin", "channel:getLiveChatSettings"] No longer supported |
livechatAgendas - JSON | scope ["api:admin", "channel:getLiveChatSettings"] No longer supported |
locked - Boolean | scope ["api:admin", "channel:getBasicInfo"] No longer supported |
meta - JSON | scope ["api:admin", "channel:getTreeSettings"] |
name - String! | scope ["api:admin", "channel:getBasicInfo"] |
on - Boolean | scope ["api:admin", "channel:getAvailabilities"] |
priorityGroups - [ChannelPriorityGroup] | scope ["api:admin", "channel:getTreeSettings"] No longer supported |
relayWebhooks - [String] | scope ["api:admin", "channel:getDetails"] No longer supported |
sendOutletMessageViaBot - Boolean | scope ["api:admin", "channel:getBroadcastGroupSettings"] No longer supported |
tags - [String] | scope ["api:admin", "channel:getBasicInfo"] |
trees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] No longer supported |
type - String | scope ["api:admin", "channel:getBasicInfo"] |
updatedAt - Long | scope ["api:admin", "channel:getBasicInfo"] |
verificationToken - String | scope ["api:admin", "channel:getDetails"] No longer supported |
wabaError - String | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
wabaInfo - JSON | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
wabaIntegration - WABAIntegration | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
wabaStatus - String | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
webhooks - JSON | scope ["api:admin", "channel:getDetails"] No longer supported |
Example
{
"_id": "4",
"app": App,
"appId": "4",
"appIntegrationAccessToken": 4,
"archived": true,
"archivedAt": {},
"availability": {},
"broadcastGroups": [ChannelBroadcastGroup],
"channelSecret": "abc123",
"connected": false,
"createdAt": {},
"description": "abc123",
"environment": ChannelEnvironment,
"environments": [ChannelEnvironment],
"etag": 4,
"exclusiveLiveChat": true,
"globalNodes": [NodeObject],
"id": "4",
"incomingWebhooks": [ChannelIncomingWebhook],
"info": {},
"inletGroup": false,
"liveChatAgendaObjects": [LiveChatAgenda],
"livechatAgendas": {},
"locked": false,
"meta": {},
"name": "xyz789",
"on": false,
"priorityGroups": [ChannelPriorityGroup],
"relayWebhooks": ["abc123"],
"sendOutletMessageViaBot": true,
"tags": ["xyz789"],
"trees": [Tree],
"type": "xyz789",
"updatedAt": {},
"verificationToken": "abc123",
"wabaError": "xyz789",
"wabaInfo": {},
"wabaIntegration": WABAIntegration,
"wabaStatus": "abc123",
"webhooks": {}
}
ChannelBroadcastGroup
Fields
| Field Name | Description |
|---|---|
groups - [BroadcastGroup] | |
label - String |
Example
{
"groups": [BroadcastGroup],
"label": "xyz789"
}
ChannelConnection
Fields
| Field Name | Description |
|---|---|
edges - [ChannelEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ChannelEdge],
"pageInfo": PageInfo
}
ChannelEdge
ChannelEnvironment
Fields
| Field Name | Description |
|---|---|
appIntegrationSignature - String | scope ["api:admin", "channel:getPlatformInfo"] |
availability - JSON | scope ["api:admin", "channel:getAvailabilities"] |
coreVersion - String | scope ["api:admin", "channel:getTreeSettings"] |
description - String | scope ["api:admin", "channel:getBasicInfo", "channel:getEnvironmentInfo"] |
envId - ID! | scope ["api:admin", "channel:getBasicInfo", "channel:getEnvironmentInfo"] |
globalNodeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
globalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] |
group - PriorityGroup | scope ["api:admin", "channel:getDetails"] |
hooks - ChannelHooks | scope ["api:admin", "channel:getDetails"] |
info - JSON | |
integration - AppIntegration | scope ["api:admin", "channel:getDetails"] |
integrationInstalled - Boolean | scope ["api:admin", "channel:getDetails"] |
livechatGlobalNodeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
livechatGlobalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] |
livechatTreeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
livechatTrees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] |
meta - JSON | scope ["api:admin", "channel:getTreeSettings"] |
name - String! | scope ["api:admin", "channel:getBasicInfo", "channel:getEnvironmentInfo"] |
offGlobalNodeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
offGlobalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] |
offTreeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
offTrees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] |
on - Boolean | scope ["api:admin", "channel:getAvailabilities"] |
treeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
trees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] |
webhooks - JSON | scope ["api:admin", "channel:getDetails"] |
webhooksV2 - [ChannelWebhookV2] | scope ["api:admin", "channel:getDetails"] |
Example
{
"appIntegrationSignature": "abc123",
"availability": {},
"coreVersion": "xyz789",
"description": "xyz789",
"envId": 4,
"globalNodeIds": ["4"],
"globalNodes": [NodeObject],
"group": PriorityGroup,
"hooks": ChannelHooks,
"info": {},
"integration": AppIntegration,
"integrationInstalled": true,
"livechatGlobalNodeIds": ["4"],
"livechatGlobalNodes": [NodeObject],
"livechatTreeIds": [4],
"livechatTrees": [Tree],
"meta": {},
"name": "xyz789",
"offGlobalNodeIds": ["4"],
"offGlobalNodes": [NodeObject],
"offTreeIds": [4],
"offTrees": [Tree],
"on": false,
"treeIds": ["4"],
"trees": [Tree],
"webhooks": {},
"webhooksV2": [ChannelWebhookV2]
}
ChannelEnvironmentWebhookDetail
Fields
| Input Field | Description |
|---|---|
alias - String | |
customHeadersData - [CustomHeadersData] | |
integrationId - String | |
memberExtraData - [MemberExtraData] | Array of member extra data to be put in webhook |
url - String! | Url to receive webhook |
webhookId - ID |
Example
{
"alias": "abc123",
"customHeadersData": [CustomHeadersData],
"integrationId": "xyz789",
"memberExtraData": [MemberExtraData],
"url": "abc123",
"webhookId": "4"
}
ChannelEnvironmentWebhooks
Fields
| Input Field | Description |
|---|---|
normalizedInbound - [ChannelEnvironmentWebhookDetail] | |
normalizedOutbound - [ChannelEnvironmentWebhookDetail] |
Example
{
"normalizedInbound": [ChannelEnvironmentWebhookDetail],
"normalizedOutbound": [ChannelEnvironmentWebhookDetail]
}
ChannelHooks
Fields
| Field Name | Description |
|---|---|
postCoreEntry - [HookFunction] | |
postCoreEntryIds - [ID] | |
preCoreEntry - ChannelPreCoreEntryHooks |
Example
{
"postCoreEntry": [HookFunction],
"postCoreEntryIds": ["4"],
"preCoreEntry": ChannelPreCoreEntryHooks
}
ChannelHooksInput
Fields
| Input Field | Description |
|---|---|
postCoreEntry - [ID] | |
preCoreEntry - ChannelPreCoreEntryHooksInput |
Example
{
"postCoreEntry": ["4"],
"preCoreEntry": ChannelPreCoreEntryHooksInput
}
ChannelIncomingWebhook
ChannelIncomingWebhookActionInput
Fields
| Input Field | Description |
|---|---|
action - String | CREATE\n Create new Incoming Webhooks\n UPDATE\n Update Incoming Webhooks using webhookId\n DELETE\n Delete Incoming Webhooks using webhookId\n UPSERT\n Create Incoming Webhooks if no non-appIntegration Incoming Webhooks exist, otherwise update all non-appIntegration Incoming Webhooks (when called using an appIntegration token, it will check for Incoming Webhook created by the appIntegration instead)\n PULL\n Delete all non-appIntegration Incoming Webhooks (when called using an appIntegration token, it will delete the Incoming Webhook created by the appIntegration instead) |
alias - String | |
disabled - Boolean | |
webhookId - ID | Used by UPDATE and DELETE action |
Example
{
"action": "abc123",
"alias": "xyz789",
"disabled": false,
"webhookId": "4"
}
ChannelPreCoreEntryHooks
Fields
| Field Name | Description |
|---|---|
asyncHookIds - [ID] | |
asyncHooks - [HookFunction] | |
syncHookIds - [ID] | |
syncHooks - [HookFunction] |
Example
{
"asyncHookIds": [4],
"asyncHooks": [HookFunction],
"syncHookIds": [4],
"syncHooks": [HookFunction]
}
ChannelPreCoreEntryHooksInput
ChannelPriorityGroup
Fields
| Field Name | Description |
|---|---|
coreVersion - String | |
globalNodeIds - [ID] | |
globalNodes - [NodeObject] | |
group - PriorityGroup | |
groupGlobalNodeIds - [ID] | |
groupGlobalNodes - [NodeObject] | |
groupTreeIds - [ID] | |
groupTrees - [Tree] | |
livechatGlobalNodeIds - [ID] | |
livechatGlobalNodes - [NodeObject] | |
livechatTreeIds - [ID] | |
livechatTrees - [Tree] | |
meta - JSON | |
offGlobalNodeIds - [ID] | |
offGlobalNodes - [NodeObject] | |
offTreeIds - [ID] | |
offTrees - [Tree] | |
override - Boolean | |
overrideOn - Boolean | |
treeIds - [ID] | |
trees - [Tree] |
Example
{
"coreVersion": "abc123",
"globalNodeIds": ["4"],
"globalNodes": [NodeObject],
"group": PriorityGroup,
"groupGlobalNodeIds": [4],
"groupGlobalNodes": [NodeObject],
"groupTreeIds": ["4"],
"groupTrees": [Tree],
"livechatGlobalNodeIds": [4],
"livechatGlobalNodes": [NodeObject],
"livechatTreeIds": [4],
"livechatTrees": [Tree],
"meta": {},
"offGlobalNodeIds": ["4"],
"offGlobalNodes": [NodeObject],
"offTreeIds": [4],
"offTrees": [Tree],
"override": false,
"overrideOn": false,
"treeIds": [4],
"trees": [Tree]
}
ChannelWebhookV2
Example
{
"alias": "abc123",
"customHeadersData": {},
"events": ["API_OUTBOUND"],
"integrationId": "xyz789",
"locked": true,
"memberExtraData": {},
"url": "abc123",
"webhookId": "4"
}
ChannelWebhookV2ActionInput
Fields
| Input Field | Description |
|---|---|
action - String | CREATE\n Create new webhooksV2\n UPDATE\n Update webhooksV2 using webhookId\n DELETE\n Delete webhooksV2 using webhookId\n UPSERT\n Create webhooksV2 if webhooksV2 with matching url and events does not exist, otherwise update the matching webhooksV2's memberExtraData and customHeadersData\n PULL\n Delete webhooksV2 that has matching url and events |
alias - String | |
customHeadersData - [CustomHeadersData] | |
events - [WebhookEventType] | |
memberExtraData - [MemberExtraData] | |
url - String | |
webhookId - ID | Used by UPDATE and DELETE action |
Example
{
"action": "abc123",
"alias": "xyz789",
"customHeadersData": [CustomHeadersData],
"events": ["API_OUTBOUND"],
"memberExtraData": [MemberExtraData],
"url": "abc123",
"webhookId": "4"
}
ChannelWebhookV2Input
Fields
| Input Field | Description |
|---|---|
alias - String | |
customHeadersData - [CustomHeadersData] | |
events - [WebhookEventType] | |
memberExtraData - [MemberExtraData] | |
url - String | |
webhookId - ID |
Example
{
"alias": "xyz789",
"customHeadersData": [CustomHeadersData],
"events": ["API_OUTBOUND"],
"memberExtraData": [MemberExtraData],
"url": "xyz789",
"webhookId": 4
}
Chat
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
admin - Admin | |
app - App | |
appId - ID | |
assignment - Assignment | No longer supported |
channel - Channel | |
channelId - ID | |
createdAt - Long! | |
deletedAt - Long | |
deliveredAt - Long | |
errors - JSON | |
etag - ID | |
failedAt - String | |
from - ChatSender | |
group - Group | No longer supported |
id - ID! | |
isMultipleParty - Boolean | |
member - Member | |
memberId - ID | |
messageEvent - JSON | |
meta - JSON | |
platform - String | |
readAt - Long | |
sentAt - Long | |
tags - [String] | |
updatedAt - Long |
Example
{
"_id": "4",
"admin": Admin,
"app": App,
"appId": "4",
"assignment": Assignment,
"channel": Channel,
"channelId": "4",
"createdAt": {},
"deletedAt": {},
"deliveredAt": {},
"errors": {},
"etag": 4,
"failedAt": "xyz789",
"from": "ADMIN",
"group": Group,
"id": 4,
"isMultipleParty": true,
"member": Member,
"memberId": 4,
"messageEvent": {},
"meta": {},
"platform": "abc123",
"readAt": {},
"sentAt": {},
"tags": ["xyz789"],
"updatedAt": {}
}
ChatConnection
Fields
| Field Name | Description |
|---|---|
edges - [ChatEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ChatEdge],
"pageInfo": PageInfo
}
ChatEdge
ChatInput
Fields
| Input Field | Description |
|---|---|
channelId - ID! | Channel Id |
deliveredAt - Long | Delivered time |
error - Error | Failed error |
externalId - ID | external Id |
failedAt - Long | Failed time |
from - ChatSender! | Message from MEMBER or BOT |
memberId - ID | Member Id |
messageEvent - JSON | Message event |
meta - JSON | |
platform - String! | Channel platform type (integration id) |
sentAt - Long | Sent time |
woztellPushId - ID | Woztell Push Id |
Example
{
"channelId": "4",
"deliveredAt": {},
"error": Error,
"externalId": 4,
"failedAt": {},
"from": "ADMIN",
"memberId": "4",
"messageEvent": {},
"meta": {},
"platform": "xyz789",
"sentAt": {},
"woztellPushId": "4"
}
ChatSender
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| |
|
|
Example
"ADMIN"
Company
CompanyInput
Example
{
"action": "xyz789",
"alias": "xyz789",
"name": "xyz789"
}
Condition
Example
{
"_id": 4,
"app": App,
"autogen": true,
"createdAt": {},
"description": "xyz789",
"etag": 4,
"functionString": "abc123",
"history": [{}],
"id": 4,
"name": "xyz789",
"system": true,
"systemKey": "abc123",
"tags": ["abc123"],
"updatedAt": {}
}
ConditionConnection
Fields
| Field Name | Description |
|---|---|
edges - [ConditionEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ConditionEdge],
"pageInfo": PageInfo
}
ConditionEdge
Coordinates
CoordinatesInput
CreateActionInput
CreateActionPayload
CreateAgendaInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channel - ID | |
clientMutationId - ID | |
completed - Boolean | |
lastRunAt - Long | |
member - ID | |
meta - JSON | |
nextRunAt - Long | |
nodeCompositeId - ID | |
pattern - String | |
priority - Int | |
replace - Boolean | |
runUntil - Long | |
subscriptionPush - AgendaSubscriptionPushConfigInput | |
tag - String | |
tree - ID | |
type - String |
Example
{
"app": 4,
"channel": 4,
"clientMutationId": 4,
"completed": true,
"lastRunAt": {},
"member": "4",
"meta": {},
"nextRunAt": {},
"nodeCompositeId": "4",
"pattern": "abc123",
"priority": 123,
"replace": true,
"runUntil": {},
"subscriptionPush": AgendaSubscriptionPushConfigInput,
"tag": "abc123",
"tree": "4",
"type": "xyz789"
}
CreateAgendaPayload
CreateAudienceInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channel - ID | |
clientMutationId - ID | |
description - String | |
filter - AudienceFilterInput | |
members - [NewAudienceMemberInput] | |
name - String | |
static - Boolean | |
tags - [String] |
Example
{
"app": "4",
"channel": 4,
"clientMutationId": "4",
"description": "abc123",
"filter": AudienceFilterInput,
"members": [NewAudienceMemberInput],
"name": "abc123",
"static": true,
"tags": ["xyz789"]
}
CreateAudiencePayload
Fields
| Field Name | Description |
|---|---|
audience - Audience | |
clientMutationId - ID | |
newAudienceResult - NewAudienceResult |
Example
{
"audience": Audience,
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult
}
CreateBroadcastInput
Fields
| Input Field | Description |
|---|---|
agendaMeta - JSON | |
app - ID | |
channel - ID | |
clientMutationId - ID | |
description - String | |
excludeAudiences - [ID] | |
filter - AudienceFilterInput | |
includeAudiences - [ID] | |
messages - JSON | Example:\n "messages" : [{\n "platforms" : [{\n "integrationId" : "woztell-essential-pack", "build" : 1, "localeGroups" : [{\n "localeGroup" : "default", "variations" : [{\n "name" : "Standard", "responses" : [{\n "type" : "TEXT", "text" : "Hello World", "id" : "EQeUe7ZA", "transform" : ""\n }] }] }] }] }] |
name - String | |
newAudience - NewAudienceInput | |
priority - Int | |
scheduleAt - Long | |
tags - [String] |
Example
{
"agendaMeta": {},
"app": 4,
"channel": "4",
"clientMutationId": 4,
"description": "abc123",
"excludeAudiences": ["4"],
"filter": AudienceFilterInput,
"includeAudiences": ["4"],
"messages": {},
"name": "abc123",
"newAudience": NewAudienceInput,
"priority": 987,
"scheduleAt": {},
"tags": ["xyz789"]
}
CreateBroadcastPayload
Fields
| Field Name | Description |
|---|---|
broadcast - SubscriptionPush | |
clientMutationId - ID | |
newAudienceResult - NewAudienceResult |
Example
{
"broadcast": SubscriptionPush,
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult
}
CreateChannelEnvironmentInput
Example
{
"app": "4",
"build": 987,
"channelId": 4,
"clientMutationId": 4,
"name": "xyz789"
}
CreateChannelInput
CreateChannelPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
clientMutationId - ID | |
error - GenericError |
Example
{
"channel": Channel,
"clientMutationId": 4,
"error": GenericError
}
CreateConditionInput
Example
{
"app": 4,
"autogen": true,
"clientMutationId": 4,
"description": "xyz789",
"functionString": "xyz789",
"name": "abc123",
"tags": ["xyz789"]
}
CreateConditionPayload
CreateDataSourceDocInput
Description
Input type for creating datasource doc.
Example
{
"app": 4,
"clientMutationId": "4",
"collectionName": "abc123",
"data": {}
}
CreateDataSourceDocPayload
CreateDataSourceInput
CreateDataSourcePayload
Description
Return type for creating datasource.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
dataSource - DataSource | Datasource that created. |
Example
{
"clientMutationId": "4",
"dataSource": DataSource
}
CreateFileInput
Example
{
"app": "4",
"channel": "4",
"clientMutationId": "4",
"fileId": 4,
"fileName": "abc123",
"fileType": "abc123",
"originalUrl": "xyz789",
"size": 123,
"tags": ["xyz789"],
"url": "abc123"
}
CreateFilePayload
CreateLocaleGroupInput
CreateLocaleGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
localeGroup - LocaleGroup |
Example
{
"clientMutationId": "4",
"localeGroup": LocaleGroup
}
CreateMemberInput
Fields
| Input Field | Description |
|---|---|
admin - ID | |
app - ID | |
botId - ID | |
botMeta - BotMetaInput | |
channel - ID! | |
clientMutationId - ID | |
customLocale - String | |
email - String | |
externalId - ID! | |
fbId - ID | |
firstName - String | |
gender - String | |
group - ID | |
inboxProfile - JSON | |
lastName - String | |
locale - String | |
meta - JSON | |
platform - String! | |
profile - JSON | |
profilePic - String | |
profilePicString - String | |
tags - [String] |
Example
{
"admin": "4",
"app": 4,
"botId": "4",
"botMeta": BotMetaInput,
"channel": "4",
"clientMutationId": 4,
"customLocale": "xyz789",
"email": "abc123",
"externalId": "4",
"fbId": 4,
"firstName": "abc123",
"gender": "xyz789",
"group": 4,
"inboxProfile": {},
"lastName": "xyz789",
"locale": "abc123",
"meta": {},
"platform": "abc123",
"profile": {},
"profilePic": "abc123",
"profilePicString": "xyz789",
"tags": ["xyz789"]
}
CreateMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
member - Member |
Example
{
"clientMutationId": "4",
"error": GenericError,
"member": Member
}
CreateNodeInput
Fields
| Input Field | Description |
|---|---|
actions - [ID] | |
analytics - AnalyticsInput | |
app - ID | |
clientMutationId - ID | |
colour - String | |
compositeId - ID | |
description - String | |
dialogflow - DialogflowSettingsInput | |
global - Boolean! | |
luis - LuisSettingsInput | |
memberTagging - MemberTaggingInput | |
name - String! | |
path - String | |
postActions - [ID] | |
preActions - [ID] | |
priority - Int | |
redirect - RedirectInput | |
responses - [ID] | |
saveCompositeId - Boolean | |
tags - [String] | |
tree - ID! | |
trigger - ID | |
type - NodeObjectType |
Example
{
"actions": [4],
"analytics": AnalyticsInput,
"app": "4",
"clientMutationId": "4",
"colour": "abc123",
"compositeId": "4",
"description": "xyz789",
"dialogflow": DialogflowSettingsInput,
"global": true,
"luis": LuisSettingsInput,
"memberTagging": MemberTaggingInput,
"name": "abc123",
"path": "xyz789",
"postActions": ["4"],
"preActions": ["4"],
"priority": 987,
"redirect": RedirectInput,
"responses": ["4"],
"saveCompositeId": false,
"tags": ["abc123"],
"tree": "4",
"trigger": "4",
"type": "DIALOGFLOW"
}
CreateNodePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
node - NodeObject |
Example
{
"clientMutationId": "4",
"node": NodeObject
}
CreateNotificationInput
Fields
| Input Field | Description |
|---|---|
appId - ID | |
buttons - [NotificationButtonInput] | |
clientMutationId - ID | |
color - String | |
emailDetail - JSON | Accepts JSON object { from, to, cc, bcc, subject, text, html, attachments, amp } |
linkTo - String | |
message - String | |
notificationCode - String | A unique identifiable string for the notification for debounced deduplication. Must be used together with timer.\n When both the notificationCode and timer are specified, the same notification (with the same notification code) will not be sent out within the time period specified in timer. |
publish - Boolean | Defaults true. If publish is false, a silent notification will be sent. |
sendEmail - Boolean | Defaults false. If true, a JSON representation of the notification will be sent via the email no-reply@woztell.com.\n The content of the email can be override by specifying the emailDetail field. |
status - String | |
timer - Long | Duration in ms for debounced deduplication (e.g. 1s = 1000). Must be used together with notificationCode.\n When both the notificationCode and timer are specified, the same notification (with the same notification code) will not be sent out within the time period specified in timer. |
title - String |
Example
{
"appId": "4",
"buttons": [NotificationButtonInput],
"clientMutationId": 4,
"color": "xyz789",
"emailDetail": {},
"linkTo": "abc123",
"message": "xyz789",
"notificationCode": "abc123",
"publish": true,
"sendEmail": true,
"status": "abc123",
"timer": {},
"title": "abc123"
}
CreateNotificationPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
notification - Notification |
Example
{
"clientMutationId": "4",
"notification": Notification
}
CreatePriorityGroupInput
CreatePriorityGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
priorityGroup - PriorityGroup |
Example
{"clientMutationId": 4, "priorityGroup": PriorityGroup}
CreateResponseInput
Example
{
"app": "4",
"clientMutationId": 4,
"description": "xyz789",
"localeGroups": [ResponseLocaleGroupInput],
"name": "xyz789",
"tags": ["abc123"]
}
CreateResponsePayload
CreateRetryAudienceInput
CreateRetryAudiencePayload
Fields
| Field Name | Description |
|---|---|
audiences - [Audience] | |
clientMutationId - ID |
Example
{"audiences": [Audience], "clientMutationId": 4}
CreateSubscriptionPushInput
Fields
| Input Field | Description |
|---|---|
agendaMeta - JSON | |
app - ID | |
channel - ID | |
clientMutationId - ID | |
description - String | |
excludeAudiences - [ID] | |
fbMessageTag - String | |
fbOTNTags - [String] | |
filter - AudienceFilterInput | |
includeAudiences - [ID] | |
members - [ID] | |
messages - JSON | Example:\n "messages" : [{\n "platforms" : [{\n "integrationId" : "woztell-essential-pack", "build" : 1, "localeGroups" : [{\n "localeGroup" : "default", "variations" : [{\n "name" : "Standard", "responses" : [{\n "type" : "TEXT", "text" : "Hello World", "id" : "EQeUe7ZA", "transform" : ""\n }] }] }] }] }] |
name - String | |
newAudience - NewAudienceInput | |
parentSubscriptionPush - ID | |
priority - Int | |
scheduleAt - Long | |
tags - [String] |
Example
{
"agendaMeta": {},
"app": 4,
"channel": 4,
"clientMutationId": 4,
"description": "abc123",
"excludeAudiences": ["4"],
"fbMessageTag": "abc123",
"fbOTNTags": ["xyz789"],
"filter": AudienceFilterInput,
"includeAudiences": ["4"],
"members": ["4"],
"messages": {},
"name": "xyz789",
"newAudience": NewAudienceInput,
"parentSubscriptionPush": "4",
"priority": 987,
"scheduleAt": {},
"tags": ["abc123"]
}
CreateSubscriptionPushPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
newAudienceResult - NewAudienceResult | |
subscriptionPush - SubscriptionPush |
Example
{
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult,
"subscriptionPush": SubscriptionPush
}
CreateTreeInput
Fields
| Input Field | Description |
|---|---|
ancestorTree - ID | |
app - ID | |
clientMutationId - ID | |
configMap - JSON | |
configMapSchema - JSON | |
description - String | |
globalNodes - [ID] | |
name - String! | |
nodes - [ID] | |
stash - [ID] | |
system - Boolean | |
tags - [String] | |
templateTreeId - ID | |
type - String | |
version - Int | |
versionAlias - String | |
workspace - [WorkspaceInput] |
Example
{
"ancestorTree": 4,
"app": 4,
"clientMutationId": "4",
"configMap": {},
"configMapSchema": {},
"description": "abc123",
"globalNodes": ["4"],
"name": "abc123",
"nodes": [4],
"stash": ["4"],
"system": false,
"tags": ["xyz789"],
"templateTreeId": 4,
"type": "abc123",
"version": 987,
"versionAlias": "abc123",
"workspace": [WorkspaceInput]
}
CreateTreePayload
CreateTriggerInput
CreateTriggerPayload
CreateWhatsAppMessageTemplateInput
Fields
| Input Field | Description |
|---|---|
category - String! | WhatsApp Template category |
channelId - ID | Stella Channel ID |
clientMutationId - ID | ID generated by relay client for tracking the progress |
components - JSON! | WhatsApp Template Components |
language - String! | WhatsApp Template language |
name - String! | WhatsApp Template Name |
wabaId - ID | WhatsApp Business Account ID |
Example
{
"category": "abc123",
"channelId": 4,
"clientMutationId": 4,
"components": {},
"language": "xyz789",
"name": "abc123",
"wabaId": "4"
}
CreateWhatsAppMessageTemplatePayload
CustomAction
Fields
| Field Name | Description |
|---|---|
api - String | No longer supported |
body - JSON | |
customBody - JSON | No longer supported |
customHeaders - JSON | No longer supported |
description - String | |
headers - JSON | |
method - String | |
modalSchema - JSON | |
modalView - String | |
title - String! | |
type - InboxIntegrationCustomActionType! | |
url - String |
Example
{
"api": "xyz789",
"body": {},
"customBody": {},
"customHeaders": {},
"description": "xyz789",
"headers": {},
"method": "abc123",
"modalSchema": {},
"modalView": "abc123",
"title": "abc123",
"type": "ACTION",
"url": "xyz789"
}
CustomHeadersData
DOB
DOBInput
DailyActiveMemberOverviewPayload
Fields
| Field Name | Description |
|---|---|
data - [DailyActiveMemberRow] | |
pageInfo - PageInfo |
Example
{
"data": [DailyActiveMemberRow],
"pageInfo": PageInfo
}
DailyActiveMemberRow
Example
{
"app": App,
"appId": "4",
"bucket": {},
"comment_messageEvent": {},
"message_messageEvent": {},
"no_of_distinct_member_comment": {},
"no_of_distinct_member_messages": {},
"no_of_distinct_member_total": {},
"total_messageEvent": {}
}
DataSource
Example
{
"collectionName": "xyz789",
"data": DataSourceConnection,
"dataByQuery": {},
"description": "xyz789",
"name": "abc123",
"shopifyIntegration": "abc123"
}
DataSourceConnection
Fields
| Field Name | Description |
|---|---|
edges - [DataSourceEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [DataSourceEdge],
"pageInfo": PageInfo
}
DataSourceData
Fields
| Field Name | Description |
|---|---|
data - JSON |
Example
{"data": {}}
DataSourceEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID | |
node - DataSourceData |
Example
{
"cursor": "4",
"node": DataSourceData
}
DeleteActionInput
DeleteActionPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteAgendaInput
DeleteAgendaPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteAudienceInput
DeleteAudiencePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteBroadcastInput
DeleteChannelEnvironmentInput
DeleteChannelEnvironmentPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
clientMutationId - ID | |
error - GenericError | |
forceRequest - Boolean |
Example
{
"channel": Channel,
"clientMutationId": "4",
"error": GenericError,
"forceRequest": true
}
DeleteChannelInput
DeleteChannelPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
errorMessage - String | |
errors - [endpointError] | |
forceRequest - Boolean |
Example
{
"clientMutationId": 4,
"error": GenericError,
"errorMessage": "xyz789",
"errors": [endpointError],
"forceRequest": false
}
DeleteConditionInput
DeleteConditionPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteDataSourceDocsInput
Description
Input type for deleting datasource doc.
Example
{
"app": "4",
"clientMutationId": "4",
"collectionName": "abc123",
"dataIds": [4],
"deleteAll": false
}
DeleteDataSourceDocsPayload
Description
Return type for deleting datasource doc.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteDataSourceInput
DeleteDataSourcePayload
Description
Return type for deleting datasource.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteFilesInput
DeleteFilesPayload
DeleteLocaleGroupInput
DeleteLocaleGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteMemberInput
DeleteMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteMembersInput
Fields
| Input Field | Description |
|---|---|
clientMutationId - ID | |
createdAtFrom - Long | |
createdAtTo - Long | |
criteria - JSON | Criteria is an array of object that is translated to a member filter.\n Small Example: [{\n "field" : "externalId",\n "operator" : "equal",\n "value" : "123"\n },{\n "field" : "channel",\n "operator" : "equal",\n "value" : "abc"\n }]\n "criteria options": \n 1.\n "field": "_id" | "tags" | "fbOTNTag",\n "filters": [{ "operator": "in" | "nin", "value": ["ID | String"]}]\n 2.\n "field": "createdAt" | "updatedAt",\n "from": "epoch number",\n "to": "epoch number"\n 3.\n "field": "firstName" | "lastName",\n "value": "String"\n 4.\n "field": "liveChat",\n "value": "Boolean"\n 5.\n "operator": "equal" | "in" | "nin" | "ne" | "regex" ("eq" does not work)\n "field": "String", (as long as field is not one of the aboves, example: "externalId", "channel", "locale", "gender", "botMeta.tempData.abc", "meta.def")\n "value": "Any" |
updatedAtFrom - Long | |
updatedAtTo - Long |
Example
{
"clientMutationId": 4,
"createdAtFrom": {},
"createdAtTo": {},
"criteria": {},
"updatedAtFrom": {},
"updatedAtTo": {}
}
DeleteMembersPayload
Fields
| Field Name | Description |
|---|---|
backgroundTask - BackgroundTask | |
clientMutationId - ID | |
error - GenericError |
Example
{
"backgroundTask": BackgroundTask,
"clientMutationId": 4,
"error": GenericError
}
DeleteNodeInput
DeleteNodePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - String |
Example
{"clientMutationId": "abc123"}
DeletePriorityGroupInput
DeletePriorityGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteResponseInput
DeleteResponsePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteSubscriptionPushInput
DeleteSubscriptionPushPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteTreeInput
DeleteTreePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteTriggerInput
DeleteTriggerPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteWhatsAppMessageTemplateInput
Example
{
"channelId": 4,
"clientMutationId": "4",
"name": "xyz789",
"wabaId": 4
}
DeleteWhatsAppMessageTemplatePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DialogflowSettings
DialogflowSettingsInput
DuplicateTreeInput
DuplicateTreePayload
EmailCred
EmailInput
Example
{
"action": "abc123",
"alias": "xyz789",
"email": "abc123"
}
Error
ExportChatsInput
Example
{
"assignment": "4",
"folder": "abc123",
"from": {},
"group": 4,
"key": "abc123",
"memberId": "xyz789",
"showHidden": true,
"timeZone": 987,
"to": {}
}
ExportChatsPayload
ExportTreesInput
Fields
| Input Field | Description |
|---|---|
trees - [String!]! |
Example
{"trees": ["abc123"]}
ExportTreesPayload
Example
{
"actions": [{}],
"conditions": [{}],
"localeGroups": [{}],
"nodes": [{}],
"responses": [{}],
"trees": [{}],
"triggers": [{}],
"url": "xyz789"
}
FailedMember
FbOTNToken
File
Example
{
"_id": 4,
"app": App,
"createdAt": {},
"error": "abc123",
"etag": 4,
"fileName": "xyz789",
"fileType": "abc123",
"id": 4,
"mediaIds": [MediaIdInfo],
"size": 123,
"tags": ["xyz789"],
"transcoded": [TranscodedFile],
"updatedAt": {},
"url": "abc123"
}
FileConnection
Fields
| Field Name | Description |
|---|---|
edges - [FileEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [FileEdge],
"pageInfo": PageInfo
}
FileEdge
FileType
FileTypeInput
FindAndModifyDataSourceDocInput
Description
Input type for find and modify datasource doc.
Fields
| Input Field | Description |
|---|---|
clientMutationId - ID | |
collectionName - ID! | Datasource id in Stella. |
filter - JSON | MongoDB filter apply to filter doc from datasource. |
options - JSON | MongoDB options in find and modify docs in datasource |
patch - JSON | MongoDB patch option to update docs in datasource |
sortBy - JSON | MongoDB sorting the filter result to modify docs in datasource |
Example
{
"clientMutationId": 4,
"collectionName": "4",
"filter": {},
"options": {},
"patch": {},
"sortBy": {}
}
FindAndModifyDataSourceDocPayload
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GenericError
Group
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
active - Boolean | |
admin - Admin! | |
adminExternalId - ID | |
adminMember - Member | |
app - App! | |
assignment - Assignment! | |
assignmentId - ID | |
botId - String | |
createdAt - Long! | |
description - String | |
etag - ID | |
externalId - String | |
icon - String | |
id - ID! | |
inlet - Channel | |
inletGroupExternalId - ID | |
inletId - ID | |
member - Member | |
memberId - ID | |
meta - JSON | |
name - String | |
outlet - Channel | |
outletId - ID | |
tags - [String] | |
type - String | |
updatedAt - Long | |
valid - Boolean |
Example
{
"_id": "4",
"active": true,
"admin": Admin,
"adminExternalId": 4,
"adminMember": Member,
"app": App,
"assignment": Assignment,
"assignmentId": "4",
"botId": "abc123",
"createdAt": {},
"description": "abc123",
"etag": "4",
"externalId": "abc123",
"icon": "abc123",
"id": "4",
"inlet": Channel,
"inletGroupExternalId": 4,
"inletId": "4",
"member": Member,
"memberId": 4,
"meta": {},
"name": "xyz789",
"outlet": Channel,
"outletId": "4",
"tags": ["xyz789"],
"type": "abc123",
"updatedAt": {},
"valid": true
}
GroupConnection
Fields
| Field Name | Description |
|---|---|
edges - [GroupEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [GroupEdge],
"pageInfo": PageInfo
}
GroupEdge
Hook
Fields
| Field Name | Description |
|---|---|
postCoreEntry - HookFunction | |
preCoreEntry - HookFunction |
Example
{
"postCoreEntry": HookFunction,
"preCoreEntry": HookFunction
}
HookFunction
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
ImportDataSourceInput
Description
Input type for importing datasource doc.
Fields
| Input Field | Description |
|---|---|
action - String! | Import action, only accept APPEND or REPLACE. |
app - ID | App ID in Stella. |
clientMutationId - ID | |
collectionName - String! | Datasource id in Stella. |
data - [JSON] | The data(s) to import into datasource |
downloadHeader - JSON | Header for requesting remote file |
format - String | Format of remote file, only accept json or csv |
parseJSON - Boolean | Only applied to remote csv file for parsing the JSON or not |
url - String | Data download Url |
Example
{
"action": "abc123",
"app": "4",
"clientMutationId": "4",
"collectionName": "xyz789",
"data": [{}],
"downloadHeader": {},
"format": "abc123",
"parseJSON": true,
"url": "xyz789"
}
ImportDataSourcePayload
ImportMembersInput
Example
{
"app": "4",
"channelId": "4",
"clientMutationId": "4",
"delimiter": "xyz789",
"mapping": {},
"platform": "xyz789",
"tags": ["xyz789"],
"url": "xyz789"
}
ImportMembersPayload
Fields
| Field Name | Description |
|---|---|
backgroundTask - BackgroundTask | |
clientMutationId - ID |
Example
{"backgroundTask": BackgroundTask, "clientMutationId": 4}
ImportTreesInput
Fields
| Input Field | Description |
|---|---|
actions - [JSON] | |
app - ID | |
conditions - [JSON] | |
force - Boolean | |
forceKeepResponsePlatforms - [String] | List of Platforms to keep the response. Ex: ["facebook", "whatsapp-cloud"]\n Note that force must be true for this to work correctly. |
localeGroups - [JSON] | |
nodes - [JSON] | |
prefix - String | |
responses - [JSON] | |
trees - [JSON] | |
triggers - [JSON] | |
url - String |
Example
{
"actions": [{}],
"app": "4",
"conditions": [{}],
"force": false,
"forceKeepResponsePlatforms": ["xyz789"],
"localeGroups": [{}],
"nodes": [{}],
"prefix": "xyz789",
"responses": [{}],
"trees": [{}],
"triggers": [{}],
"url": "abc123"
}
ImportTreesPayload
Fields
| Field Name | Description |
|---|---|
trees - [Tree] | |
uninstalledIntegrations - [UninstalledIntegration] |
Example
{
"trees": [Tree],
"uninstalledIntegrations": [UninstalledIntegration]
}
InboxIntegration
Fields
| Field Name | Description |
|---|---|
folderActions - [CustomAction] | |
inputActions - [CustomAction] | |
messageActions - [CustomAction] |
Example
{
"folderActions": [CustomAction],
"inputActions": [CustomAction],
"messageActions": [CustomAction]
}
InboxIntegrationCustomActionType
Values
| Enum Value | Description |
|---|---|
|
| No longer supported |
|
| |
|
|
Example
"ACTION"
InboxMemberProfile
Fields
| Field Name | Description |
|---|---|
addresses - [Address] | |
companies - [Company] | |
company - String | |
dob - DOB | |
emails - [ProfileEmail] | |
firstName - String | |
gender - String | |
lastName - String | |
locale - String | |
middleName - String | |
name - String | |
phones - [Phone] | |
profilePicUrl - String | |
title - String | |
website - String | |
websites - [Website] |
Example
{
"addresses": [Address],
"companies": [Company],
"company": "xyz789",
"dob": DOB,
"emails": [ProfileEmail],
"firstName": "abc123",
"gender": "abc123",
"lastName": "xyz789",
"locale": "abc123",
"middleName": "abc123",
"name": "abc123",
"phones": [Phone],
"profilePicUrl": "abc123",
"title": "abc123",
"website": "xyz789",
"websites": [Website]
}
InboxMemberProfileInput
Fields
| Input Field | Description |
|---|---|
addresses - [AddressInput] | |
companies - [CompanyInput] | |
company - String | |
dob - DOBInput | |
emails - [EmailInput] | |
firstName - String | |
gender - String | |
lastName - String | |
locale - String | |
middleName - String | |
name - String | |
phones - [PhoneInput] | |
profilePicUrl - String | |
setProfileArray - Boolean | |
title - String | |
website - String | |
websites - [WebsiteInput] |
Example
{
"addresses": [AddressInput],
"companies": [CompanyInput],
"company": "xyz789",
"dob": DOBInput,
"emails": [EmailInput],
"firstName": "abc123",
"gender": "abc123",
"lastName": "abc123",
"locale": "xyz789",
"middleName": "xyz789",
"name": "xyz789",
"phones": [PhoneInput],
"profilePicUrl": "xyz789",
"setProfileArray": true,
"title": "abc123",
"website": "abc123",
"websites": [WebsiteInput]
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntMax100
Description
minimum 0, maximum 100
Example
IntMax100
IntegrationEndpoints
Example
{
"channelCreate": "xyz789",
"channelDelete": "abc123",
"channelResubscribe": "abc123",
"channelUnsubscribe": "xyz789",
"install": "xyz789",
"memberDelete": "abc123",
"messageSend": "xyz789",
"postUpdate": "abc123",
"preUpdate": "abc123",
"ticketCreate": "abc123",
"ticketInactivate": "xyz789",
"uninstall": "xyz789"
}
IntegrationTree
IntegrationView
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
LiveChatAgenda
LocaleGroup
LocaleGroupConnection
Fields
| Field Name | Description |
|---|---|
edges - [LocaleGroupEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [LocaleGroupEdge],
"pageInfo": PageInfo
}
LocaleGroupEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - LocaleGroup |
Example
{"cursor": 4, "node": LocaleGroup}
Long
Description
Long Integer type
Example
{}
LuisSettings
LuisSettingsInput
ManagedApp
MediaIdInfo
MediaIdInfoInput
Member
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
admin - Admin | |
adminId - ID | |
app - App! | |
appId - ID! | |
assignment - ID | No longer supported |
botId - ID | |
botMeta - BotMeta | |
channel - Channel | |
channelId - ID | |
createdAt - Long! | |
customLocale - String | |
email - String | |
etag - ID | |
externalId - ID | |
fbId - ID | |
fbOTNTokens - [FbOTNToken] | |
firstName - String | |
gender - String | |
group - Group | No longer supported |
id - ID! | |
inboxProfile - InboxMemberProfile | |
inletGroup - Boolean | |
lastName - String | |
locale - String | |
meta - JSON | |
name - String | |
notes - [Note] | Free-text notes that the agent can add to the member |
platform - String! | |
profile - MemberProfile | |
profilePic - String | |
profilePicString - String | |
tags - [String] | |
updatedAt - Long |
Example
{
"_id": "4",
"admin": Admin,
"adminId": "4",
"app": App,
"appId": "4",
"assignment": 4,
"botId": 4,
"botMeta": BotMeta,
"channel": Channel,
"channelId": "4",
"createdAt": {},
"customLocale": "abc123",
"email": "abc123",
"etag": "4",
"externalId": 4,
"fbId": 4,
"fbOTNTokens": [FbOTNToken],
"firstName": "abc123",
"gender": "xyz789",
"group": Group,
"id": "4",
"inboxProfile": InboxMemberProfile,
"inletGroup": false,
"lastName": "abc123",
"locale": "abc123",
"meta": {},
"name": "abc123",
"notes": [Note],
"platform": "abc123",
"profile": MemberProfile,
"profilePic": "xyz789",
"profilePicString": "xyz789",
"tags": ["xyz789"],
"updatedAt": {}
}
MemberConnection
Fields
| Field Name | Description |
|---|---|
edges - [MemberEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [MemberEdge],
"pageInfo": PageInfo
}
MemberEdge
MemberExtraData
Fields
| Input Field | Description |
|---|---|
field - String | Field name in webhook under memberExtra |
path - String | Path under member data. Ref: https://doc.woztell.com/docs/reference/member-reference |
Example
{
"field": "xyz789",
"path": "abc123"
}
MemberProfile
Fields
| Field Name | Description |
|---|---|
addresses - [Address] | |
avatar_hash - String | |
city - String | |
companies - [Company] | |
country - String | |
displayName - String | |
display_name - String | |
display_name_normalized - String | |
dob - DOB | |
email - String | |
emails - [ProfileEmail] | |
fields - JSON | |
firstName - String | |
first_name - String | |
gender - String | |
groupid - Int | |
headimgurl - String | |
id - String | |
image_24 - String | |
image_32 - String | |
image_48 - String | |
image_72 - String | |
image_192 - String | |
image_512 - String | |
image_1024 - String | |
image_original - String | |
is_bot - Boolean | |
language - String | |
language_code - String | |
lastName - String | |
last_name - String | |
locale - String | |
middleName - String | |
name - String | |
nickname - String | |
openid - String | |
phones - [Phone] | |
profilePic - String | |
profilePicUrl - String | |
profile_pic - String | |
province - String | |
qr_scene - Int | |
qr_scene_str - String | |
real_name - String | |
real_name_normalized - String | |
remark - String | |
sex - Int | |
status_emoji - String | |
status_text - String | |
subscribe - Int | |
subscribe_scene - String | |
subscribe_time - Long | |
tagid_list - [Int] | |
tbId - Int | |
team - String | |
timezone - Int | |
title - String | |
username - String | |
websites - [Website] |
Example
{
"addresses": [Address],
"avatar_hash": "abc123",
"city": "xyz789",
"companies": [Company],
"country": "abc123",
"displayName": "xyz789",
"display_name": "abc123",
"display_name_normalized": "xyz789",
"dob": DOB,
"email": "abc123",
"emails": [ProfileEmail],
"fields": {},
"firstName": "xyz789",
"first_name": "xyz789",
"gender": "abc123",
"groupid": 987,
"headimgurl": "xyz789",
"id": "xyz789",
"image_24": "abc123",
"image_32": "xyz789",
"image_48": "xyz789",
"image_72": "abc123",
"image_192": "xyz789",
"image_512": "abc123",
"image_1024": "abc123",
"image_original": "xyz789",
"is_bot": false,
"language": "abc123",
"language_code": "xyz789",
"lastName": "xyz789",
"last_name": "xyz789",
"locale": "xyz789",
"middleName": "abc123",
"name": "abc123",
"nickname": "xyz789",
"openid": "abc123",
"phones": [Phone],
"profilePic": "abc123",
"profilePicUrl": "abc123",
"profile_pic": "abc123",
"province": "xyz789",
"qr_scene": 123,
"qr_scene_str": "xyz789",
"real_name": "abc123",
"real_name_normalized": "xyz789",
"remark": "abc123",
"sex": 987,
"status_emoji": "abc123",
"status_text": "abc123",
"subscribe": 123,
"subscribe_scene": "abc123",
"subscribe_time": {},
"tagid_list": [123],
"tbId": 123,
"team": "xyz789",
"timezone": 123,
"title": "abc123",
"username": "abc123",
"websites": [Website]
}
MemberProfileInput
Fields
| Input Field | Description |
|---|---|
addresses - [AddressInput] | |
avatar_hash - String | |
city - String | |
country - String | |
displayName - String | |
display_name - String | |
display_name_normalized - String | |
dob - DOBInput | |
email - String | |
emails - [EmailInput] | |
fields - JSON | |
firstName - String | |
first_name - String | |
gender - String | |
groupid - Int | |
headimgurl - String | |
id - String | |
image_24 - String | |
image_32 - String | |
image_48 - String | |
image_72 - String | |
image_192 - String | |
image_512 - String | |
image_1024 - String | |
image_original - String | |
is_bot - Boolean | |
language - String | |
language_code - String | |
lastName - String | |
last_name - String | |
locale - String | |
middleName - String | |
name - String | |
nickname - String | |
openid - String | |
phones - [PhoneInput] | |
profilePic - String | |
profilePicUrl - String | |
profile_pic - String | |
province - String | |
qr_scene - Int | |
qr_scene_str - String | |
real_name - String | |
real_name_normalized - String | |
remark - String | |
sex - Int | |
status_emoji - String | |
status_text - String | |
subscribe - Int | |
subscribe_scene - String | |
subscribe_time - Long | |
tagid_list - [Int] | |
tbId - Int | |
team - String | |
timezone - Int | |
title - String | |
username - String |
Example
{
"addresses": [AddressInput],
"avatar_hash": "abc123",
"city": "abc123",
"country": "xyz789",
"displayName": "xyz789",
"display_name": "abc123",
"display_name_normalized": "abc123",
"dob": DOBInput,
"email": "abc123",
"emails": [EmailInput],
"fields": {},
"firstName": "abc123",
"first_name": "abc123",
"gender": "xyz789",
"groupid": 123,
"headimgurl": "xyz789",
"id": "abc123",
"image_24": "xyz789",
"image_32": "abc123",
"image_48": "abc123",
"image_72": "abc123",
"image_192": "abc123",
"image_512": "abc123",
"image_1024": "xyz789",
"image_original": "abc123",
"is_bot": true,
"language": "abc123",
"language_code": "xyz789",
"lastName": "xyz789",
"last_name": "abc123",
"locale": "abc123",
"middleName": "xyz789",
"name": "abc123",
"nickname": "abc123",
"openid": "xyz789",
"phones": [PhoneInput],
"profilePic": "abc123",
"profilePicUrl": "abc123",
"profile_pic": "abc123",
"province": "abc123",
"qr_scene": 123,
"qr_scene_str": "abc123",
"real_name": "xyz789",
"real_name_normalized": "abc123",
"remark": "abc123",
"sex": 123,
"status_emoji": "abc123",
"status_text": "xyz789",
"subscribe": 123,
"subscribe_scene": "abc123",
"subscribe_time": {},
"tagid_list": [987],
"tbId": 123,
"team": "xyz789",
"timezone": 987,
"title": "xyz789",
"username": "xyz789"
}
MemberTagging
MemberTaggingInput
MergeMembersByExternalIdsInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channel - ID | Channel ID for the two merging members |
clientMutationId - ID | |
finalExternalId - ID | The external ID of the member that should overwrite the priorExternalId |
meta - JSON | A meta object to insert into the final member after the merge finishes |
priorExternalId - ID | The external ID of the member that should be replaced by the finalExternalId |
Example
{
"app": 4,
"channel": "4",
"clientMutationId": 4,
"finalExternalId": "4",
"meta": {},
"priorExternalId": "4"
}
MergeMembersByExternalIdsPayload
Fields
| Field Name | Description |
|---|---|
action - String | The result of the merge.\n PriorMemberMergedToFinalMember: Both Prior Member and Final Member were found. Prior Member is deleted. Final Member receive the chats and priorityGroups of the Prior Member. Tree, Node and LiveChat status is copied from Prior Member as well. The meta input is also inserted to the Final Member.\n UpdatedPriorMemberWithFinalExternalId: Only Prior Member was found. Thus Prior Member has its externalId updated from priorExternalId to finalExternalId and also gets the meta input data.\n NoPriorMemberToMerge: Only Final Member was found. The meta input data is insert to the Final Member.\n PriorAndFinalMembersNotFound: Neither Members were found. No member is created or updated.\n |
clientMutationId - ID | |
member - Member | The final member after prior member is deleted |
Example
{
"action": "abc123",
"clientMutationId": "4",
"member": Member
}
Message
Fields
| Field Name | Description |
|---|---|
localeGroups - [ResponseLocaleGroup] |
Example
{"localeGroups": [ResponseLocaleGroup]}
ModifyMemberTagsInput
Fields
| Input Field | Description |
|---|---|
appId - ID | The identifier for the app the user is using. Used to filter the appID |
channel - ID | When using externalId, control which channel's externalId member to update |
clientMutationId - ID | Client mutation id for relay |
externalId - ID | Dangerous!!! May have same externalId under same app, use channel to update the correct member! The external identifier for the user. Used to filter if memberId is missing |
memberId - ID | The identifier for the user. Used to filter to the correct user |
tags - [String]! | Array of tags for adding / removing |
Example
{
"appId": "4",
"channel": 4,
"clientMutationId": "4",
"externalId": "4",
"memberId": "4",
"tags": ["abc123"]
}
ModifyMemberTagsPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | Client mutation id for relay |
err - String | The error message. Returns a string explaining what error has occurred. |
err_code - Int | The error code. Returns the code of the error. |
member - Member | |
memberId - ID | ID of modified member |
ok - Int | Used signify whether the action has succeed. Returning 1 for success, 0 for failure. |
Example
{
"clientMutationId": 4,
"err": "xyz789",
"err_code": 987,
"member": Member,
"memberId": "4",
"ok": 987
}
MongoDBArrayOption
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
|
Example
"addToSet"
NLPAnalyticsCounter
Example
{
"agent_id": "xyz789",
"app": App,
"appId": "4",
"average_confidence_level": {},
"bucket": {},
"intent_id": "xyz789",
"intent_name": "abc123",
"no_of_nlp_analytics": {},
"type": "abc123"
}
NLPAnalyticsCounterConnection
Fields
| Field Name | Description |
|---|---|
edges - [NLPAnalyticsCounterEdge] | |
pageInfo - PageInfo | |
total_no_of_nlp_analytics - Long! |
Example
{
"edges": [NLPAnalyticsCounterEdge],
"pageInfo": PageInfo,
"total_no_of_nlp_analytics": {}
}
NLPAnalyticsCounterEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - NLPAnalyticsCounter |
Example
{
"cursor": "4",
"node": NLPAnalyticsCounter
}
NewAudienceInput
Fields
| Input Field | Description |
|---|---|
members - [NewAudienceMemberInput] |
Example
{"members": [NewAudienceMemberInput]}
NewAudienceMemberDataInput
Example
{
"botMetaTempData": {},
"email": "xyz789",
"firstName": "abc123",
"gender": "xyz789",
"lastName": "xyz789",
"locale": "xyz789",
"meta": {},
"name": "xyz789",
"profilePic": "abc123",
"tags": ["xyz789"]
}
NewAudienceMemberInput
Fields
| Input Field | Description |
|---|---|
data - NewAudienceMemberDataInput | |
externalId - ID | |
memberId - ID |
Example
{
"data": NewAudienceMemberDataInput,
"externalId": "4",
"memberId": "4"
}
NewAudienceResult
Fields
| Field Name | Description |
|---|---|
audienceId - ID! | |
failedMembers - [FailedMember] | |
newMemberIds - [ID] | |
removedMemberIds - [ID] | |
updatedMemberIds - [ID] |
Example
{
"audienceId": "4",
"failedMembers": [FailedMember],
"newMemberIds": [4],
"removedMemberIds": ["4"],
"updatedMemberIds": ["4"]
}
NewMemberCounter
NewMemberCounterConnection
Fields
| Field Name | Description |
|---|---|
data - [NewMemberCounter] | |
pageInfo - PageInfo | |
total_no_of_comment_member - Long | |
total_no_of_member - Long |
Example
{
"data": [NewMemberCounter],
"pageInfo": PageInfo,
"total_no_of_comment_member": {},
"total_no_of_member": {}
}
Node
Fields
| Field Name | Description |
|---|---|
id - ID! |
Possible Types
| Node Types |
|---|
Example
{"id": "4"}
NodeObject
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
actionIds - [ID] | |
actions - [Action] | |
analytics - Analytics | |
app - App! | |
appId - ID | |
colour - String | |
compositeId - ID | |
createdAt - Long! | |
description - String | |
dialogflow - DialogflowSettings | |
etag - ID | |
global - Boolean | |
history - [JSON] | |
id - ID! | |
locked - Boolean | |
luis - LuisSettings | |
memberTagging - MemberTagging | |
name - String! | |
path - String | |
postActionIds - [ID] | |
postActions - [Action] | |
preActionIds - [ID] | |
preActions - [Action] | |
priority - Float | |
redirect - Redirect | |
responseIds - [ID] | |
responses - [Response] | |
saveCompositeId - Boolean | |
tags - [String] | |
templateTreeId - ID | |
tree - Tree | |
treeId - ID | |
trigger - Trigger | |
triggerId - ID | |
type - NodeObjectType | |
updatedAt - Long |
Example
{
"_id": "4",
"actionIds": ["4"],
"actions": [Action],
"analytics": Analytics,
"app": App,
"appId": 4,
"colour": "abc123",
"compositeId": "4",
"createdAt": {},
"description": "abc123",
"dialogflow": DialogflowSettings,
"etag": "4",
"global": false,
"history": [{}],
"id": "4",
"locked": false,
"luis": LuisSettings,
"memberTagging": MemberTagging,
"name": "abc123",
"path": "abc123",
"postActionIds": ["4"],
"postActions": [Action],
"preActionIds": ["4"],
"preActions": [Action],
"priority": 987.65,
"redirect": Redirect,
"responseIds": ["4"],
"responses": [Response],
"saveCompositeId": false,
"tags": ["xyz789"],
"templateTreeId": "4",
"tree": Tree,
"treeId": 4,
"trigger": Trigger,
"triggerId": 4,
"type": "DIALOGFLOW",
"updatedAt": {}
}
NodeObjectConnection
Fields
| Field Name | Description |
|---|---|
edges - [NodeObjectEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [NodeObjectEdge],
"pageInfo": PageInfo
}
NodeObjectEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - NodeObject |
Example
{"cursor": 4, "node": NodeObject}
NodeObjectType
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Example
"DIALOGFLOW"
NormalIntegrationInput
Note
NoteInput
Notification
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
app - App! | |
appId - ID | |
backgroundTaskId - ID | |
buttons - [NotificationButton] | Maximum 2 buttons are allowed. |
color - String | Color of the notification. Accepts HEX color code. |
createdAt - Long! | |
etag - ID | |
id - ID! | |
linkTo - String | A relative path to the Woztell Platform, so when user click on this notification, user will be directed to the page. |
message - String | |
new - Boolean | |
status - String | When status is specified, the color of the notification will be predefined and the status will be the title of the notification.\n So the color and title will be ignored.\n status can be either "SUCCESS" / "RUNNING" / "PENDING" / "ERROR", which corresponding to different colors, green, blue, grey and red |
title - String | Title of the notification. Max 80 characters. |
type - String | Type of notification for catorgorization. Possible values are BACKGROUND_TASK | INTEGRATION | API |
updatedAt - Long |
Example
{
"_id": 4,
"app": App,
"appId": "4",
"backgroundTaskId": 4,
"buttons": [NotificationButton],
"color": "xyz789",
"createdAt": {},
"etag": 4,
"id": "4",
"linkTo": "abc123",
"message": "xyz789",
"new": false,
"status": "abc123",
"title": "xyz789",
"type": "xyz789",
"updatedAt": {}
}
NotificationButton
Fields
| Field Name | Description |
|---|---|
path - String | A relative path to the Woztell Platform, so when user click on this button with path, user will be directed to the page. |
text - String! | The title of the button |
url - String | An absolute URL. When user click on this button, a new tab with this URL will be opened. |
Example
{
"path": "xyz789",
"text": "abc123",
"url": "abc123"
}
NotificationButtonInput
PageInfo
Pair
PairInput
Partner
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
activated - Boolean | |
alias - String | |
createdAt - Long! | |
entEnabled - Boolean | |
etag - ID | |
id - ID! | |
info - JSON | |
managedApps - [ManagedApp] | |
managedAppsCount - Int | |
meta - JSON | |
name - String! | |
partnerTier - String | |
skipCC - Boolean | |
teamMembers - [TeamMember] | |
updatedAt - Long | |
Example
{
"_id": 4,
"activated": true,
"alias": "xyz789",
"createdAt": {},
"entEnabled": false,
"etag": "4",
"id": 4,
"info": {},
"managedApps": [ManagedApp],
"managedAppsCount": 987,
"meta": {},
"name": "xyz789",
"partnerTier": "abc123",
"skipCC": false,
"teamMembers": [TeamMember],
"updatedAt": {}
}
Phone
PhoneInput
Example
{
"action": "abc123",
"alias": "abc123",
"number": "abc123"
}
PlatformCred
Fields
| Field Name | Description |
|---|---|
fbUserId - String |
Example
{"fbUserId": "xyz789"}
PlatformIntegrationInput
PostCommentAnalyticsOverview
Example
{
"app": App,
"appId": "4",
"no_of_matched_comment": {},
"no_of_non_matched_comment": {},
"post_id": "abc123",
"total_no_of_comment": {}
}
PostCommentAnalyticsOverviewConnection
Fields
| Field Name | Description |
|---|---|
edges - [PostCommentAnalyticsOverviewEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [PostCommentAnalyticsOverviewEdge],
"pageInfo": PageInfo
}
PostCommentAnalyticsOverviewEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - PostCommentAnalyticsOverview |
Example
{"cursor": 4, "node": PostCommentAnalyticsOverview}
PresignedURLForUploadInput
PresignedURLForUploadPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
fields - JSON | |
ok - Int | |
url - String |
Example
{
"clientMutationId": 4,
"error": GenericError,
"fields": {},
"ok": 987,
"url": "abc123"
}
PriorityGroup
Example
{
"_id": "4",
"app": App,
"channel": Channel,
"createdAt": {},
"description": "xyz789",
"etag": 4,
"id": 4,
"memberIds": [4],
"members": [Member],
"name": "xyz789",
"tags": ["xyz789"],
"updatedAt": {}
}
PriorityGroupConnection
Fields
| Field Name | Description |
|---|---|
edges - [PriorityGroupEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [PriorityGroupEdge],
"pageInfo": PageInfo
}
PriorityGroupEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - PriorityGroup |
Example
{"cursor": 4, "node": PriorityGroup}
ProfileEmail
PullAppIntegrationInput
PullAppIntegrationPayload
Description
The return payload for PullAppIntegration. Used to delete an integration from the database.
Example
{
"err": "xyz789",
"err_code": 987,
"ok": 123
}
PullKeyInput
PutAppIntegrationInput
PutAppIntegrationPayload
Description
The return payload for PutAppIntegration. Used to put an integration to the database.
Fields
| Field Name | Description |
|---|---|
app - App | |
appId - ID | |
clientMutationId - ID | |
err - String | The error message. Returns a string explaining what error has occurred. |
err_code - Int | The error code. Returns the code of the error. |
integrationId - ID | An ID of an integration. The ID for the newly put integration. |
ok - Int | Used signify whether the action has succeed. Returning 1 for success, 0 for failure. |
Example
{
"app": App,
"appId": "4",
"clientMutationId": "4",
"err": "abc123",
"err_code": 987,
"integrationId": "4",
"ok": 987
}
Redirect
RedirectInput
RemoveNoteFromMemberInput
RemoveNoteFromMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
member - Member |
Example
{
"clientMutationId": 4,
"error": GenericError,
"member": Member
}
ResourceTemplate
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
alias - String | |
build - Int | |
createdAt - Long! | |
description - String | |
etag - ID | |
for - [String] | |
functionString - String | |
id - ID! | |
integrationId - ID | |
masked - Boolean | |
name - String! | |
preview - String | |
published - Boolean | |
requestedVerification - Boolean | |
schema - JSON | |
type - String | |
updatedAt - Long | |
validatorFunctionString - String | |
verified - Boolean |
Example
{
"_id": "4",
"alias": "xyz789",
"build": 987,
"createdAt": {},
"description": "abc123",
"etag": "4",
"for": ["abc123"],
"functionString": "abc123",
"id": 4,
"integrationId": 4,
"masked": true,
"name": "xyz789",
"preview": "xyz789",
"published": false,
"requestedVerification": false,
"schema": {},
"type": "xyz789",
"updatedAt": {},
"validatorFunctionString": "xyz789",
"verified": false
}
Response
Example
{
"_id": "4",
"app": App,
"createdAt": {},
"description": "xyz789",
"etag": "4",
"history": [{}],
"id": 4,
"localeGroups": [ResponseLocaleGroup],
"name": "abc123",
"pickResponse": {},
"tags": ["abc123"],
"updatedAt": {}
}
ResponseConnection
Fields
| Field Name | Description |
|---|---|
edges - [ResponseEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ResponseEdge],
"pageInfo": PageInfo
}
ResponseEdge
ResponseLocaleGroup
Fields
| Field Name | Description |
|---|---|
localeGroup - LocaleGroup | |
variations - [ResponseVariation] |
Example
{
"localeGroup": LocaleGroup,
"variations": [ResponseVariation]
}
ResponseLocaleGroupInput
Fields
| Input Field | Description |
|---|---|
localeGroup - ID! | |
variations - [ResponseVariationInput] |
Example
{"localeGroup": 4, "variations": [ResponseVariationInput]}
ResponseObject
ResponseObjectInput
ResponseVariation
Fields
| Field Name | Description |
|---|---|
name - String! | |
platforms - [ResponseObject] |
Example
{
"name": "abc123",
"platforms": [ResponseObject]
}
ResponseVariationInput
Fields
| Input Field | Description |
|---|---|
name - String! | |
platforms - [ResponseObjectInput] |
Example
{
"name": "abc123",
"platforms": [ResponseObjectInput]
}
ResumableUploadInput
ResumableUploadPayload
RetrieveFilePayload
Example
{
"fileId": 4,
"fileType": "abc123",
"fileTypeV2": FileType,
"size": {},
"transcoded": true,
"transcodingError": GenericError,
"url": "xyz789"
}
Role
Example
{
"_id": 4,
"acls": ["abc123"],
"app": App,
"createdAt": {},
"etag": 4,
"id": "4",
"name": "xyz789",
"system": true,
"tags": ["abc123"],
"updatedAt": {}
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SubscribeChannelInput
SubscribeChannelPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
clientMutationId - ID | |
error - GenericError |
Example
{
"channel": Channel,
"clientMutationId": "4",
"error": GenericError
}
SubscriptionPush
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
agendaMeta - JSON | |
agendas - [Agenda] | |
app - App! | |
appId - ID | |
childSubscriptionPushIds - [ID] | |
childSubscriptionPushes - [SubscriptionPush] | |
createdAt - Long! | |
description - String | |
errorStats - [SubscriptionPushErrorStats] | |
errors - [SubscriptionPushError] | |
etag - ID | |
excludeAudiences - [Audience] | |
fbMessageTag - String | |
fbOTNTags - [String] | |
filter - AudienceFilter | |
id - ID! | |
includeAudiences - [Audience] | |
interacted - [ID] | |
interactedCount - Long | |
memberCount - Long | |
memberIds - [ID] | |
members - MemberConnection | |
messages - JSON | |
messagesHydrated - [Message] | |
name - String | |
parentSubscriptionPush - SubscriptionPush | |
parentSubscriptionPushId - ID | |
priority - Int | |
read - [ID] | |
readCount - Long | |
scheduleAt - Long | |
sent - [ID] | |
sentCount - Long | |
sentEnd - Long | |
sentStart - Long | |
source - String | |
tags - [String] | |
updatedAt - Long | |
Example
{
"_id": 4,
"agendaMeta": {},
"agendas": [Agenda],
"app": App,
"appId": 4,
"childSubscriptionPushIds": ["4"],
"childSubscriptionPushes": [SubscriptionPush],
"createdAt": {},
"description": "abc123",
"errorStats": [SubscriptionPushErrorStats],
"errors": [SubscriptionPushError],
"etag": 4,
"excludeAudiences": [Audience],
"fbMessageTag": "abc123",
"fbOTNTags": ["abc123"],
"filter": AudienceFilter,
"id": "4",
"includeAudiences": [Audience],
"interacted": ["4"],
"interactedCount": {},
"memberCount": {},
"memberIds": [4],
"members": MemberConnection,
"messages": {},
"messagesHydrated": [Message],
"name": "abc123",
"parentSubscriptionPush": SubscriptionPush,
"parentSubscriptionPushId": "4",
"priority": 123,
"read": ["4"],
"readCount": {},
"scheduleAt": {},
"sent": [4],
"sentCount": {},
"sentEnd": {},
"sentStart": {},
"source": "abc123",
"tags": ["xyz789"],
"updatedAt": {}
}
SubscriptionPushConnection
Fields
| Field Name | Description |
|---|---|
edges - [SubscriptionPushEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [SubscriptionPushEdge],
"pageInfo": PageInfo
}
SubscriptionPushEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - SubscriptionPush |
Example
{"cursor": 4, "node": SubscriptionPush}
SubscriptionPushError
SubscriptionPushErrorInput
SubscriptionPushErrorStats
SupportedMediaTypes
Fields
| Field Name | Description |
|---|---|
audio - [FileType] | |
image - [FileType] | |
video - [FileType] |
Example
{
"audio": [FileType],
"image": [FileType],
"video": [FileType]
}
TagFilter
Description
An object made up of an operator and an array of tags
Fields
| Input Field | Description |
|---|---|
operator - String | A string of operator. This filter only accepts IN or NIN.\n IN: Filter the result to members that have matching tags.\n NIN: Filter the result to members that do not have matching tags. |
tags - [String] | An array of strings for tags. Used together with operator to filter members based on their tags. |
Example
{
"operator": "xyz789",
"tags": ["xyz789"]
}
TeamMember
Example
{
"acls": ["abc123"],
"allAcls": ["abc123"],
"email": "xyz789",
"expiry": {},
"grantAt": {},
"grantBy": User,
"grantById": 4,
"inviteToken": 4,
"roles": [Role],
"status": "xyz789",
"user": User
}
Ticket
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
active - Boolean | |
app - App! | |
appId - ID | |
assignedAt - Long | |
assignee - Member | scope ["api:admin", "member:getDetails"] |
assigneeId - ID | |
createdAt - Long! | |
etag - ID | |
externalId - ID | |
history - Boolean | |
id - ID! | |
inactivatedAt - Long | |
inlet - Channel | scope ["api:admin", "channel:getAvailabilities", "channel:getBasicInfo", "channel:getBroadcastGroupSettings", "channel:getLiveChatSettings", "channel:getPlatformInfo", "channel:getPlatformSettings", "channel:getTreeSettings"] |
inletId - ID | |
label - String | |
masterTicketId - ID! | |
member - Member | scope ["api:admin", "member:getDetails"] |
memberId - ID | |
meta - JSON | |
outlet - Channel | scope ["api:admin", "channel:getAvailabilities", "channel:getBasicInfo", "channel:getBroadcastGroupSettings", "channel:getLiveChatSettings", "channel:getPlatformInfo", "channel:getPlatformSettings", "channel:getTreeSettings"] |
outletId - ID | |
parentTicket - Ticket | scope ["ticket:get"] |
parentTicketId - ID | |
previousTicket - Ticket | scope ["ticket:get"] |
previousTicketId - ID | |
reassign - Boolean | |
status - String | |
updatedAt - Long |
Example
{
"_id": "4",
"active": false,
"app": App,
"appId": "4",
"assignedAt": {},
"assignee": Member,
"assigneeId": 4,
"createdAt": {},
"etag": "4",
"externalId": "4",
"history": false,
"id": "4",
"inactivatedAt": {},
"inlet": Channel,
"inletId": "4",
"label": "xyz789",
"masterTicketId": "4",
"member": Member,
"memberId": "4",
"meta": {},
"outlet": Channel,
"outletId": 4,
"parentTicket": Ticket,
"parentTicketId": "4",
"previousTicket": Ticket,
"previousTicketId": 4,
"reassign": false,
"status": "xyz789",
"updatedAt": {}
}
TicketDataConnection
TranscodedFile
Tree
Fields
| Field Name | Description |
|---|---|
_id - ID! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
ancestorTree - Tree | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
app - App | scope ["api:admin", "tree:getBasicInfo", "appInfo:get", "appSettings:get", "botbuilder:read"] |
appId - ID | scope ["api:admin", "tree:getBasicInfo", "appInfo:get", "appSettings:get", "botbuilder:read"] |
configMap - JSON | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
configMapSchema - JSON | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
createdAt - Long! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
description - String | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
etag - ID | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
globalNodeIds - [ID] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
globalNodes - [NodeObject] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
id - ID! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
locked - Boolean | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
name - String! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
nodeIds - [ID] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
nodes - [NodeObject] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
Arguments
| |
siblingTrees - [Tree] | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
stash - [NodeObject] | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
system - Boolean | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
tags - [String] | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
templateTree - Tree | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
templateTreeId - ID | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
type - String | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
updatedAt - Long | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
version - Int | scope ["api:admin", "api:admin", "tree:getBasicInfo", "botbuilder:read"] |
versionAlias - String | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
workspace - [Workspace] | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
Example
{
"_id": 4,
"ancestorTree": Tree,
"app": App,
"appId": "4",
"configMap": {},
"configMapSchema": {},
"createdAt": {},
"description": "abc123",
"etag": 4,
"globalNodeIds": [4],
"globalNodes": [NodeObject],
"id": "4",
"locked": true,
"name": "abc123",
"nodeIds": ["4"],
"nodes": [NodeObject],
"siblingTrees": [Tree],
"stash": [NodeObject],
"system": false,
"tags": ["abc123"],
"templateTree": Tree,
"templateTreeId": "4",
"type": "abc123",
"updatedAt": {},
"version": 987,
"versionAlias": "xyz789",
"workspace": [Workspace]
}
TreeConnection
Fields
| Field Name | Description |
|---|---|
edges - [TreeEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [TreeEdge],
"pageInfo": PageInfo
}
TreeEdge
Trigger
Example
{
"_id": "4",
"app": App,
"conditions": {},
"createdAt": {},
"description": "abc123",
"etag": "4",
"history": [{}],
"id": 4,
"name": "abc123",
"rawConditions": {},
"tags": ["xyz789"],
"templateInfo": {},
"updatedAt": {}
}
TriggerConnection
Fields
| Field Name | Description |
|---|---|
edges - [TriggerEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [TriggerEdge],
"pageInfo": PageInfo
}
TriggerEdge
UninstalledIntegration
Example
{
"build": 123,
"icon": "xyz789",
"integrationId": "4",
"integrationName": "xyz789",
"isPlatform": false,
"private": true,
"version": "abc123"
}
UnsetKeysInput
UnsubscribeChannelInput
UnsubscribeChannelPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
errorMessage - String | |
errors - [endpointError] | |
forceRequest - Boolean |
Example
{
"clientMutationId": "4",
"error": GenericError,
"errorMessage": "xyz789",
"errors": [endpointError],
"forceRequest": true
}
UpdateActionInput
Example
{
"actionId": 4,
"app": 4,
"clientMutationId": "4",
"description": "xyz789",
"etag": "4",
"functionString": "xyz789",
"history": [{}],
"name": "xyz789",
"tags": ["abc123"]
}
UpdateActionPayload
UpdateAgendaInput
Fields
| Input Field | Description |
|---|---|
agendaId - ID! | |
app - ID | |
clientMutationId - ID | |
completed - Boolean | |
etag - ID | |
member - ID | |
meta - JSON | |
nextRunAt - Long | |
nodeCompositeId - ID | |
pattern - String | |
priority - Int | |
runUntil - Long | |
subscriptionPush - AgendaSubscriptionPushConfigInput | |
tag - String | |
tree - ID | |
type - String |
Example
{
"agendaId": 4,
"app": "4",
"clientMutationId": "4",
"completed": true,
"etag": "4",
"member": 4,
"meta": {},
"nextRunAt": {},
"nodeCompositeId": 4,
"pattern": "abc123",
"priority": 123,
"runUntil": {},
"subscriptionPush": AgendaSubscriptionPushConfigInput,
"tag": "abc123",
"tree": "4",
"type": "xyz789"
}
UpdateAgendaPayload
UpdateAppIntegrationInput
Description
An input for UpdateAppIntegration.
Example
{
"appId": 4,
"clientMutationId": "4",
"integration": {},
"integrationId": "4"
}
UpdateAppIntegrationMetaInput
UpdateAppIntegrationMetaPayload
Fields
| Field Name | Description |
|---|---|
appIntegration - AppIntegration | |
clientMutationId - ID |
Example
{"appIntegration": AppIntegration, "clientMutationId": 4}
UpdateAppIntegrationPayload
UpdateAudienceInput
Fields
| Input Field | Description |
|---|---|
action - String | UPSERT\n Create / Update members and then add them to the audience\n DELETE\n Remove members from the audience\n |
app - ID | |
audienceId - ID! | |
channel - ID | |
clientMutationId - ID | |
description - String | |
etag - ID | |
filter - AudienceFilterInput | |
members - [NewAudienceMemberInput] | |
name - String | |
static - Boolean | |
tags - [String] |
Example
{
"action": "xyz789",
"app": 4,
"audienceId": "4",
"channel": "4",
"clientMutationId": "4",
"description": "abc123",
"etag": 4,
"filter": AudienceFilterInput,
"members": [NewAudienceMemberInput],
"name": "xyz789",
"static": false,
"tags": ["abc123"]
}
UpdateAudiencePayload
Fields
| Field Name | Description |
|---|---|
audience - Audience | |
clientMutationId - ID | |
newAudienceResult - NewAudienceResult |
Example
{
"audience": Audience,
"clientMutationId": 4,
"newAudienceResult": NewAudienceResult
}
UpdateBroadcastInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
broadcastId - ID! | |
clientMutationId - ID | |
description - String | |
etag - ID | |
excludeAudiences - [ID] | |
filter - AudienceFilterInput | |
includeAudiences - [ID] | |
messages - JSON | Example:\n "messages" : [{\n "platforms" : [{\n "integrationId" : "woztell-essential-pack", "build" : 1, "localeGroups" : [{\n "localeGroup" : "default", "variations" : [{\n "name" : "Standard", "responses" : [{\n "type" : "TEXT", "text" : "Hello World", "id" : "EQeUe7ZA", "transform" : ""\n }] }] }] }] }] |
name - String | |
priority - Int | |
scheduleAt - Long | |
tags - [String] |
Example
{
"app": "4",
"broadcastId": "4",
"clientMutationId": "4",
"description": "xyz789",
"etag": 4,
"excludeAudiences": ["4"],
"filter": AudienceFilterInput,
"includeAudiences": ["4"],
"messages": {},
"name": "xyz789",
"priority": 123,
"scheduleAt": {},
"tags": ["xyz789"]
}
UpdateBroadcastPayload
Fields
| Field Name | Description |
|---|---|
broadcast - SubscriptionPush | |
clientMutationId - ID |
Example
{
"broadcast": SubscriptionPush,
"clientMutationId": "4"
}
UpdateChannelEnvironmentHooksInput
Example
{
"app": 4,
"channelId": 4,
"clientMutationId": 4,
"environmentId": 4,
"option": "abc123",
"postCoreEntry": [4],
"preCoreEntryAsync": [4],
"preCoreEntrySync": ["4"]
}
UpdateChannelEnvironmentInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
availability - JSON | Tree Availability setting |
channelId - ID! | Target channel Id |
clientMutationId - ID | |
coreVersion - String | Environment core version |
environmentId - ID | Target environment id (default: default) |
globalNodeIds - [ID] | Default global modes Ids |
group - ID | Priority Group ID |
hooks - ChannelHooksInput | Environment hooks |
livechatGlobalNodeIds - [ID] | Live chat global modes Ids |
livechatTreeIds - [ID] | Live chat Tree ids |
meta - JSON | |
name - String | Environment name |
offGlobalNodeIds - [ID] | Off global modes Ids |
offTreeIds - [ID] | Off Tree ids |
on - Boolean | Environment global on/off toggle |
option - String | Option on tree and node ids, only accept $addToSet or $set |
treeIds - [ID] | Default Tree ids |
webhooks - ChannelEnvironmentWebhooks | Environment webhooks (old format) |
webhooksV2 - [ChannelWebhookV2Input] | Environment webhooks (new format) |
Example
{
"app": "4",
"availability": {},
"channelId": "4",
"clientMutationId": 4,
"coreVersion": "abc123",
"environmentId": 4,
"globalNodeIds": [4],
"group": 4,
"hooks": ChannelHooksInput,
"livechatGlobalNodeIds": ["4"],
"livechatTreeIds": ["4"],
"meta": {},
"name": "abc123",
"offGlobalNodeIds": [4],
"offTreeIds": [4],
"on": false,
"option": "xyz789",
"treeIds": ["4"],
"webhooks": ChannelEnvironmentWebhooks,
"webhooksV2": [ChannelWebhookV2Input]
}
UpdateChannelEnvironmentLivechatTreeGlobalNodeInput
Example
{
"app": 4,
"channelId": "4",
"clientMutationId": "4",
"environmentId": 4,
"livechatGlobalNodes": [4],
"livechatTrees": [4],
"option": "abc123"
}
UpdateChannelEnvironmentOffTreeGlobalNodeInput
Example
{
"app": "4",
"channelId": "4",
"clientMutationId": 4,
"environmentId": 4,
"offGlobalNodes": ["4"],
"offTrees": ["4"],
"option": "abc123"
}
UpdateChannelEnvironmentTreeGlobalNodeInput
Example
{
"app": "4",
"channelId": "4",
"clientMutationId": 4,
"environmentId": 4,
"globalNodes": ["4"],
"option": "abc123",
"trees": ["4"]
}
UpdateChannelEnvironmentWebhooksInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channelId - ID! | Target channel Id |
clientMutationId - ID | |
environmentId - ID | Target environment id (default: default) |
normalizedInbound - [ChannelEnvironmentWebhookDetail] | Environment inbound webhooks (old format) |
normalizedOutbound - [ChannelEnvironmentWebhookDetail] | Environment outbound webhooks (old format) |
option - String | Only accept $addToSet or $pull, only used for normalizedInbound normalizedOutbound inputs |
webhooksV2 - [ChannelWebhookV2ActionInput] | Environment webhooks (new format) |
Example
{
"app": "4",
"channelId": 4,
"clientMutationId": "4",
"environmentId": 4,
"normalizedInbound": [ChannelEnvironmentWebhookDetail],
"normalizedOutbound": [ChannelEnvironmentWebhookDetail],
"option": "abc123",
"webhooksV2": [ChannelWebhookV2ActionInput]
}
UpdateChannelIncomingWebhookInput
Fields
| Input Field | Description |
|---|---|
channelId - ID! | |
clientMutationId - ID | |
etag - ID | |
incomingWebhooks - [ChannelIncomingWebhookActionInput] |
Example
{
"channelId": 4,
"clientMutationId": 4,
"etag": 4,
"incomingWebhooks": [ChannelIncomingWebhookActionInput]
}
UpdateChannelIncomingWebhookPayload
UpdateChannelInput
Example
{
"app": 4,
"channelId": "4",
"clientMutationId": 4,
"description": "abc123",
"etag": 4,
"meta": {},
"name": "abc123",
"on": false,
"tags": ["xyz789"]
}
UpdateChannelPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
clientMutationId - ID | |
error - GenericError |
Example
{
"channel": Channel,
"clientMutationId": "4",
"error": GenericError
}
UpdateChannelPriorityGroupInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channelId - ID! | |
coreVersion - String | |
globalNodeIds - [ID] | |
groupGlobalNodeIds - [ID] | |
groupTreeIds - [ID] | |
livechatGlobalNodeIds - [ID] | |
livechatTreeIds - [ID] | |
meta - JSON | |
offGlobalNodeIds - [ID] | |
offTreeIds - [ID] | |
option - String | |
override - Boolean | |
overrideOn - Boolean | |
priorityGroupId - String | |
treeIds - [ID] |
Example
{
"app": 4,
"channelId": "4",
"coreVersion": "abc123",
"globalNodeIds": [4],
"groupGlobalNodeIds": ["4"],
"groupTreeIds": ["4"],
"livechatGlobalNodeIds": [4],
"livechatTreeIds": ["4"],
"meta": {},
"offGlobalNodeIds": [4],
"offTreeIds": ["4"],
"option": "abc123",
"override": true,
"overrideOn": false,
"priorityGroupId": "abc123",
"treeIds": [4]
}
UpdateConditionInput
Example
{
"app": 4,
"autogen": true,
"clientMutationId": "4",
"conditionId": "4",
"description": "abc123",
"etag": 4,
"functionString": "xyz789",
"history": [{}],
"name": "xyz789",
"tags": ["abc123"]
}
UpdateConditionPayload
UpdateDataSourceDocInput
Description
Input type for updating datasource doc.
Example
{
"app": 4,
"clientMutationId": 4,
"collectionName": "abc123",
"data": {},
"etag": "4"
}
UpdateDataSourceDocPayload
UpdateDataSourceDocsInput
Description
Input type for updating datasource docs.
Fields
| Input Field | Description |
|---|---|
clientMutationId - ID | |
collectionName - ID! | Datasource id in Stella. |
filter - JSON | MongoDB filter apply to filter doc from datasource. |
multi - Boolean | Update multi documents or not |
options - JSON | MongoDB options in updating docs in datasource |
patch - JSON | MongoDB patch option to update docs in datasource |
Example
{
"clientMutationId": 4,
"collectionName": 4,
"filter": {},
"multi": false,
"options": {},
"patch": {}
}
UpdateDataSourceDocsPayload
UpdateDataSourceInput
Description
Input type for updating datasource.
Example
{
"app": 4,
"clientMutationId": 4,
"collectionName": 4,
"description": "xyz789",
"name": "xyz789"
}
UpdateDataSourcePayload
Description
Return type for updating datasource.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
dataSource - DataSource | Datasource that updated. |
Example
{
"clientMutationId": "4",
"dataSource": DataSource
}
UpdateFileMediaIdsInput
Fields
| Input Field | Description |
|---|---|
app - ID! | |
clientMutationId - ID | |
fileId - ID! | |
mediaIds - [MediaIdInfoInput] |
Example
{
"app": 4,
"clientMutationId": "4",
"fileId": "4",
"mediaIds": [MediaIdInfoInput]
}
UpdateFileMediaIdsPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
mediaIds - [MediaIdInfo] |
Example
{
"clientMutationId": "4",
"error": GenericError,
"mediaIds": [MediaIdInfo]
}
UpdateLocaleGroupInput
UpdateLocaleGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
localeGroup - LocaleGroup |
Example
{"clientMutationId": 4, "localeGroup": LocaleGroup}
UpdateMemberForBotPayload
UpdateMemberInput
Fields
| Input Field | Description |
|---|---|
addToSetKeys - [AddToSetKeyInput] | |
admin - ID | |
app - ID | |
botMeta - BotMetaInput | |
channel - ID | |
clientMutationId - ID | |
customLocale - String | |
email - String | |
etag - ID | |
externalId - ID | |
firstName - String | |
gender - String | |
group - ID | |
inboxProfile - InboxMemberProfileInput | |
lastName - String | |
locale - String | |
memberId - ID | |
meta - JSON | |
profile - JSON | |
profilePic - String | |
profilePicString - String | |
profileWithSchema - MemberProfileInput | |
pullKeys - [PullKeyInput] | |
tags - [String] | |
unsetKeys - UnsetKeysInput |
Example
{
"addToSetKeys": [AddToSetKeyInput],
"admin": "4",
"app": 4,
"botMeta": BotMetaInput,
"channel": "4",
"clientMutationId": 4,
"customLocale": "xyz789",
"email": "xyz789",
"etag": "4",
"externalId": "4",
"firstName": "abc123",
"gender": "xyz789",
"group": "4",
"inboxProfile": InboxMemberProfileInput,
"lastName": "abc123",
"locale": "abc123",
"memberId": "4",
"meta": {},
"profile": {},
"profilePic": "xyz789",
"profilePicString": "xyz789",
"profileWithSchema": MemberProfileInput,
"pullKeys": [PullKeyInput],
"tags": ["abc123"],
"unsetKeys": UnsetKeysInput
}
UpdateMemberPayload
UpdateMembersInput
UpdateMembersPayload
UpdateNodeInput
Fields
| Input Field | Description |
|---|---|
actions - [ID] | |
analytics - AnalyticsInput | |
app - ID | |
clientMutationId - ID | |
colour - String | |
description - String | |
dialogflow - DialogflowSettingsInput | |
etag - ID | |
global - Boolean | |
luis - LuisSettingsInput | |
memberTagging - MemberTaggingInput | |
name - String | |
nodeId - ID! | |
path - String | |
postActions - [ID] | |
preActions - [ID] | |
priority - Int | |
redirect - RedirectInput | |
responses - [ID] | |
saveCompositeId - Boolean | |
tags - [String] | |
trigger - ID | |
type - NodeObjectType |
Example
{
"actions": ["4"],
"analytics": AnalyticsInput,
"app": 4,
"clientMutationId": 4,
"colour": "xyz789",
"description": "xyz789",
"dialogflow": DialogflowSettingsInput,
"etag": "4",
"global": false,
"luis": LuisSettingsInput,
"memberTagging": MemberTaggingInput,
"name": "abc123",
"nodeId": "4",
"path": "xyz789",
"postActions": ["4"],
"preActions": [4],
"priority": 123,
"redirect": RedirectInput,
"responses": [4],
"saveCompositeId": false,
"tags": ["abc123"],
"trigger": 4,
"type": "DIALOGFLOW"
}
UpdateNodePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
node - NodeObject |
Example
{
"clientMutationId": "4",
"node": NodeObject
}
UpdateNoteInput
UpdateNotePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
error - GenericError | |
note - Note |
Example
{
"clientMutationId": 4,
"error": GenericError,
"note": Note
}
UpdatePairsInAppInput
Description
An input for UpdatePairsInApp
Fields
| Input Field | Description |
|---|---|
clientMutationId - ID | |
pairs - [PairInput]! | Pair array for inlet and outlet |
Example
{"clientMutationId": 4, "pairs": [PairInput]}
UpdatePairsInAppPayload
UpdatePriorityGroupInput
Example
{
"app": 4,
"channel": "4",
"clientMutationId": "4",
"description": "abc123",
"etag": 4,
"members": ["4"],
"name": "abc123",
"priorityGroupId": "4",
"tags": ["abc123"]
}
UpdatePriorityGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
priorityGroup - PriorityGroup |
Example
{"clientMutationId": 4, "priorityGroup": PriorityGroup}
UpdateResponseInput
Example
{
"app": "4",
"clientMutationId": 4,
"description": "xyz789",
"etag": "4",
"history": [{}],
"localeGroups": [ResponseLocaleGroupInput],
"name": "xyz789",
"responseId": 4,
"tags": ["xyz789"]
}
UpdateResponsePayload
UpdateSubscriptionPushInput
Fields
| Input Field | Description |
|---|---|
agendaMeta - JSON | |
agendas - [ID] | |
app - ID | |
childSubscriptionPushes - [ID] | |
clientMutationId - ID | |
description - String | |
errors - [SubscriptionPushErrorInput] | |
etag - ID | |
excludeAudiences - [ID] | |
fbMessageTag - String | |
fbOTNTags - [String] | |
filter - AudienceFilterInput | |
includeAudiences - [ID] | |
interacted - [ID] | |
members - [ID] | |
messages - JSON | Example:\n "messages" : [{\n "platforms" : [{\n "integrationId" : "woztell-essential-pack", "build" : 1, "localeGroups" : [{\n "localeGroup" : "default", "variations" : [{\n "name" : "Standard", "responses" : [{\n "type" : "TEXT", "text" : "Hello World", "id" : "EQeUe7ZA", "transform" : ""\n }] }] }] }] }] |
name - String | |
priority - Int | |
read - [ID] | |
scheduleAt - Long | |
sent - [ID] | |
sentEnd - Long | |
sentStart - Long | |
subscriptionPushId - ID! | |
tags - [String] |
Example
{
"agendaMeta": {},
"agendas": [4],
"app": 4,
"childSubscriptionPushes": [4],
"clientMutationId": "4",
"description": "abc123",
"errors": [SubscriptionPushErrorInput],
"etag": "4",
"excludeAudiences": ["4"],
"fbMessageTag": "abc123",
"fbOTNTags": ["abc123"],
"filter": AudienceFilterInput,
"includeAudiences": [4],
"interacted": ["4"],
"members": [4],
"messages": {},
"name": "xyz789",
"priority": 123,
"read": [4],
"scheduleAt": {},
"sent": ["4"],
"sentEnd": {},
"sentStart": {},
"subscriptionPushId": "4",
"tags": ["abc123"]
}
UpdateSubscriptionPushPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
subscriptionPush - SubscriptionPush |
Example
{
"clientMutationId": "4",
"subscriptionPush": SubscriptionPush
}
UpdateTreeInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
clientMutationId - ID | |
configMap - JSON | |
configMapSchema - JSON | |
description - String | |
etag - ID | |
globalNodes - [ID] | |
name - String | |
nodes - [ID] | |
stash - [ID] | |
system - Boolean | |
tags - [String] | |
templateTreeId - ID | |
treeId - ID! | |
type - String | |
versionAlias - String | |
workspace - [WorkspaceInput] |
Example
{
"app": 4,
"clientMutationId": "4",
"configMap": {},
"configMapSchema": {},
"description": "abc123",
"etag": "4",
"globalNodes": ["4"],
"name": "abc123",
"nodes": ["4"],
"stash": [4],
"system": false,
"tags": ["abc123"],
"templateTreeId": "4",
"treeId": "4",
"type": "abc123",
"versionAlias": "abc123",
"workspace": [WorkspaceInput]
}
UpdateTreePayload
UpdateTriggerInput
Example
{
"app": "4",
"clientMutationId": 4,
"conditions": {},
"description": "abc123",
"etag": 4,
"history": [{}],
"name": "xyz789",
"tags": ["abc123"],
"templateInfo": {},
"triggerId": 4
}
UpdateTriggerPayload
UpdateWebchatMemberForBotInput
Example
{
"admin": 4,
"app": "4",
"botMeta": {},
"channel": "4",
"clientMutationId": 4,
"customLocale": "xyz789",
"group": "4",
"locale": "xyz789",
"memberId": "4",
"meta": {},
"tags": ["xyz789"],
"webchatToken": "4"
}
UpsertDataSourceDocsInput
UpsertDataSourceDocsPayload
UpsertMemberByExternalIdInput
Fields
| Input Field | Description |
|---|---|
admin - ID | |
app - ID | |
botId - ID | |
botMeta - BotMetaInput | |
channel - ID! | |
clientMutationId - ID | |
conversationId - String | |
customLocale - String | |
email - String | |
externalId - ID! | |
fbId - ID | |
fbOTNToken - JSON | |
fbUserRef - Boolean | |
firstName - String | |
gender - String | |
group - ID | |
lastName - String | |
locale - String | |
meta - JSON | |
name - String | |
newExternalId - ID | |
platform - String! | |
profile - JSON | |
profilePic - String | |
profilePicString - String | |
tags - [String] | |
trackActiveMember - Boolean | |
trackNewMember - Boolean | |
webchatToken - ID! |
Example
{
"admin": 4,
"app": "4",
"botId": 4,
"botMeta": BotMetaInput,
"channel": 4,
"clientMutationId": 4,
"conversationId": "xyz789",
"customLocale": "abc123",
"email": "xyz789",
"externalId": 4,
"fbId": "4",
"fbOTNToken": {},
"fbUserRef": false,
"firstName": "abc123",
"gender": "xyz789",
"group": 4,
"lastName": "xyz789",
"locale": "abc123",
"meta": {},
"name": "abc123",
"newExternalId": 4,
"platform": "abc123",
"profile": {},
"profilePic": "xyz789",
"profilePicString": "abc123",
"tags": ["abc123"],
"trackActiveMember": false,
"trackNewMember": false,
"webchatToken": "4"
}
UpsertMemberByExternalIdPayload
User
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
acls - [String] | scope ["api:admin", "user:getRoles"] |
apps - [UserAppConfig] | scope ["api:admin", "user:getApps"] |
createdAt - Long! | |
email - EmailCred | scope ["api:admin", "user:getProfile", "teamMember:list"] |
etag - ID | |
firstName - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
fullName - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
id - ID! | |
lastName - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
meta - JSON | |
ownRoles - [Role] | scope ["api:admin", "user:getRoles"] |
partners - [UserPartnerConfig] | scope ["api:admin", "user:getPartners"] |
platformCred - PlatformCred | |
preferences - UserPreferences | |
profilePic - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
sessionMeta - JSON | |
stripeProducts - JSON | |
tags - [String] | |
updatedAt - Long |
Example
{
"_id": "4",
"acls": ["xyz789"],
"apps": [UserAppConfig],
"createdAt": {},
"email": EmailCred,
"etag": 4,
"firstName": "abc123",
"fullName": "xyz789",
"id": 4,
"lastName": "xyz789",
"meta": {},
"ownRoles": [Role],
"partners": [UserPartnerConfig],
"platformCred": PlatformCred,
"preferences": UserPreferences,
"profilePic": "xyz789",
"sessionMeta": {},
"stripeProducts": {},
"tags": ["xyz789"],
"updatedAt": {}
}
UserAppConfig
UserPartnerConfig
UserPreferences
WABAIntegration
WebhookEventType
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Example
"API_OUTBOUND"
Website
WebsiteInput
Example
{
"action": "xyz789",
"alias": "xyz789",
"url": "xyz789"
}
WhatsAppFileUrl
WhatsAppMessageTemplate
WhatsAppMessageTemplateConnection
Fields
| Field Name | Description |
|---|---|
edges - [WhatsAppMessageTemplateEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [WhatsAppMessageTemplateEdge],
"pageInfo": PageInfo
}
WhatsAppMessageTemplateEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID | |
node - WhatsAppMessageTemplate |
Example
{
"cursor": "4",
"node": WhatsAppMessageTemplate
}
Workspace
Fields
| Field Name | Description |
|---|---|
coordinates - Coordinates | |
meta - JSON | |
node - NodeObject |
Example
{
"coordinates": Coordinates,
"meta": {},
"node": NodeObject
}
WorkspaceInput
Fields
| Input Field | Description |
|---|---|
coordinates - CoordinatesInput | |
node - ID |
Example
{"coordinates": CoordinatesInput, "node": 4}
endpointError
toggleLiveChatInput
Description
An input for ToggleLiveChat
Fields
| Input Field | Description |
|---|---|
appId - ID | The identifier for the app the user is using. Used to filter the appID |
channel - ID | When using externalId, control which channel's externalId member to update |
clientMutationId - ID | Client mutation id for relay |
externalId - ID | Dangerous!!! May have same externalId under same app, use channel to update the correct member! The external identifier for the user. Used to filter if memberId is missing |
liveChat - Boolean! | The boolean input for the toggle action. LiveChat will be set to this boolean |
memberId - ID | The identifier for the user. Used to filter to the correct user |
Example
{
"appId": 4,
"channel": 4,
"clientMutationId": "4",
"externalId": 4,
"liveChat": false,
"memberId": 4
}
toggleLiveChatPayload
Description
The return payload for ToggleLiveChat. Used to toggle the Live Chat setting for the user.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | Client mutation id for relay |
err - String | The error message. Returns a string explaining what error has occurred. |
err_code - Int | The error code. Returns the code of the error. |
member - Member | |
memberId - ID | |
ok - Int | Used signify whether the action has succeed. Returning 1 for success, 0 for failure. |
Example
{
"clientMutationId": "4",
"err": "abc123",
"err_code": 987,
"member": Member,
"memberId": "4",
"ok": 987
}