Reference

Types

Every type the API's operations use, with all of its fields

The full shape of everything the operations accept and return - 350 types in all. Field types link to each other, so you can follow a response down to its leaves.

AIAssistant

Fields

_idString!Required
nameString!Required
Human-readable name for the assistant
organisationIdString!Required
Organization this assistant belongs to
integrationIntegration
Integration for AI provider
modelModelInfo
AI model configuration
modelSlotsModelSlots
Per-purpose model configuration (chat, image, audio, vision)
mediaSettingsAIAssistantMediaSettings
Per-assistant inbound-media processing toggles
customModelString
Custom model name (required when model is CUSTOM)
contextAIAssistantContext
Assistant context configuration
settingsAIAssistantSettings
Advanced AI settings
isDefaultBoolean!Required
Whether this is the default assistant for the organization
isSystemBoolean!Required
Whether this is a system-provided AI assistant (platform-managed, usage-tracked)
isAdditionalSystemBoolean
True for an extra system agent the org created (shares the platform integration, deletable). False for the original System AI.
isActiveBoolean!Required
Whether this assistant is active and can be used
isValidBoolean!Required
Whether this assistant has valid configuration (integration and model present)
knowledgeBaseMedia
Knowledge base media file for this assistant
knowledgeBaseAudienceKnowledgeAudience
Who the AI may answer from the knowledge base file for (null = everyone)
searchHelpArticlesBoolean!Required
Let the assistant answer from the org's published Help articles (retrieved in relevant slices, not sent whole)
searchNewsBoolean!Required
Let the assistant answer from the org's published News posts
skills[String!]!Required
Enabled Skill ids on this assistant (ordered). Empty array means AI Skills is OFF for this assistant - falls through to the legacy one-shot AI reply path.
permissionOverridesJSON
Operator overrides over the catalogue default permission level per tool key. Only stores deviations from defaults. Shape: { "<category>.<operation>": "NONE" | "AUTO" | "USER_CONFIRM" | "OPERATOR_APPROVE" }.
maxTurnsPerExecutionFloat
Hard cap on LLM turns per AI Skills execution. Default 8. Drives the engine to terminate runaway loops where the LLM keeps calling tools without producing a final reply.
maxToolCallsPerExecutionFloat
Hard cap on cumulative tool calls per AI Skills execution. Default 12.
confidenceEscalationThresholdFloat
Self-evaluation confidence threshold (0-1). After the AI Skills loop emits a final reply, the assistant scores its own confidence; if the score is below this threshold, the engine ESCALATES to operator instead of sending the reply. Default 0 = never escalates on confidence (Phase-5 behavior). Typical operator-set values: 0.4-0.6.
createdByString!Required
User who created this assistant
createdAtDateTime!Required
Creation timestamp
updatedAtDateTime!Required
Last update timestamp

AIAssistantContext

Fields

identityString
Assistant identity and role description
publicNameString
The assistant's VISITOR-FACING name - what it calls itself to end customers on every channel (e.g. answering "what's your name?"). Falls back to the "Gaia" brand default when unset. Distinct from the dashboard-internal name label.
languageString
Language the assistant should use
toneString
Tone of voice for the assistant
capabilitiesString
Description of what users can do in this chat service
objectiveString
Main objective for the assistant
instructionsString
Additional instructions for the assistant

AIAssistantMediaSettings

Fields

analyzeImagesBoolean
Analyze inbound images (vision)
analyzeDocumentsBoolean
Extract text from inbound documents
transcribeAudioBoolean
Auto-transcribe inbound audio/voice (Whisper)
analyzeVideoBoolean
Analyze inbound video frames (vision)

AIAssistantSettings

Fields

maxTokensFloat
Maximum tokens for responses
temperatureFloat
Temperature setting (0.0 to 2.0)
topPFloat
Top-p setting for nucleus sampling
frequencyPenaltyFloat
Frequency penalty (-2.0 to 2.0)
presencePenaltyFloat
Presence penalty (-2.0 to 2.0)

ActionButton

Fields

idString!Required
labelString!Required
styleString
kindString!Required

ActionContext

Fields

executionIdString
callIdString

ActiveFlowExecution

Fields

flowIdString!Required
Flow MongoDB ID
flowTitleString!Required
Human-readable flow title
executionIdString
Execution context ID
initiatorFlowInitiator
Who started the flow
operatorUser
Operator who started the flow (when initiator is OPERATOR)
startedAtDateTime!Required
When the flow execution started

AddOrgMemberDirectInput

Input fields

emailString!Required
roleRole!Required
nameString

AiAutoReplyMode

Value
ORG_DEFAULT
SPECIFIC
DISABLED
RULES

AiAutoReplyRule

Fields

conditionJSON!Required
json-logic condition over facts: authMethod, isAuthenticated, verified, field.<key>
assistantIdID!Required
Assistant that answers when this matches

AiAutoReplyRuleInput

Input fields

conditionJSON!Required
json-logic condition over facts: authMethod, isAuthenticated, verified, field.<key>
assistantIdID!Required

AssignmentInitiator

Value
SYSTEM
OPERATOR
VISITOR

AssistantPinSource

Value
RULE
OPERATOR
DEFAULT

AuthMethod

Value
ANONYMOUS
JWT
GOOGLE
PASSKEY

AuthProvider

Value
GOOGLE
APPLE
MICROSOFT
GITHUB
FACEBOOK
PASSKEY
SSO
MOCK

BlockScope

Value
CONTACT
THREAD

Bot

Fields

_idString
integrationString
Integration ID that holds the bot token
organisationIdString
Organisation ID this bot belongs to
botIdFloat
firstNameString
lastNameString
usernameString
typeString
languageString
canJoinGroupsBoolean
canReadAllGroupMessagesBoolean
supportInlineQueriesBoolean
canConnectToBusinessBoolean
hasMainWebAppBoolean
isBotBoolean
createdAtDateTime
updatedAtDateTime

CarouselCardOverride

Input fields

cardIndexInt!Required
Card index (0-based)
headerMediaIdString
Media ID for the card header. Must be a valid Media document ID. Overrides the default card media.
bodyVariables[String!]
Body variable values for this card in order: {{1}}, {{2}}, etc.

CatalogActionInput

Input fields

thumbnailProductRetailerIdString
Product retailer ID for the catalog thumbnail. If omitted, WhatsApp uses the first product from the catalog.

ChannelIdentity

Fields

nameString
photoString

Chat

Fields

_idString!Required
chatIdFloat
externalChatIdString
businessConnectionIdString
externalUserIdString
typeChatType!Required
titleString
usernameString
firstNameString
lastNameString
isForumBoolean
lastMessageMessage
lastMessageAtDateTime
profilePeople
channelIdentityChannelIdentity
integrationIdString
Integration ID (use integration field for full details)
createdAtDateTime
updatedAtDateTime
unReadCountFloat
engagedBoolean
True once the conversation has real engagement (a visitor inbound message OR a human-operator message). false = captured/hidden from the operator inbox; absent/unset = visible (legacy rows + all non-web channels). Set explicitly, never defaulted.
isBlockedBoolean
verified[String!]
isAIActiveBoolean
statusChatStatus
categoryChatCategory
priorityPriority
collections[String!]
lastUserMessageAtDateTime
isWithin24hWindowBoolean
assignedToUser
Operator currently assigned to this chat
assignedAtDateTime
When the operator was assigned
assignedStatusChatAssignmentStatus
Operator connection state (pending / connected).
copilotAssistantIdString
AI assistant assigned to this chat (overrides org/operator defaults)
copilotAssistantPinnedByAssistantPinSource
Who pinned the chat AI assistant (rule / operator / default)
copilotAssistantRuleIndexInt
Index of the matched agent-selection rule (pinnedBy RULE)
activeFlowExecutionActiveFlowExecution
Currently active flow execution, or null if no flow running
outboundPausedBoolean
Whether outbound is paused by spam protection
contextSnapshotJSON
kindString
conversationIdString
groupTitleString
threadKeyString
isWithinHumanAgentWindowBoolean
members[ChatMember!]!Required
integrationIntegration

ChatAssignmentStatus

Value
PENDING
CONNECTED

ChatCategory

Value
SUPPORT
SALES
GENERAL
FEEDBACK
INQUIRY

ChatCollection

Fields

_idString!Required
nameString!Required
slugString!Required
descriptionString
iconString
colorString
positionFloat!Required
isSystemBoolean!Required
systemKeyString
isVisibleBoolean!Required
isLockedBoolean!Required
planLockedBoolean!Required
rules[CollectionRule!]!Required
createdByString
chatCountFloat
createdAtDateTime!Required
updatedAtDateTime!Required

ChatFieldKey

Value
IS_BLOCKED
AI_AVAILABLE
CHAT_STATUS
CHAT_CATEGORY
PRIORITY
VERIFIED

ChatMember

Fields

participantIdID!Required
contactIdID
peopleIdID
roleString!Required
joinedAtDateTime
displayPeople

ChatMemberPage

Fields

members[ChatMember!]!Required
totalCountInt!Required
Count of CURRENT (non-left) members matching the same filter as members - never counts a member who has left.

ChatStatus

Value
ISSUE
RESOLVED
PENDING
IN_PROGRESS
CLOSED

ChatType

Value
PRIVATE
GROUP
SUPERGROUP
CHANNEL

CleanupDeletedCounts

Fields

membersInt!Required
chatsInt!Required
messagesInt!Required
messageReactionsInt!Required
peopleInt!Required
labelsInt!Required
mediaInt!Required
integrationsInt!Required
chatCollectionsInt!Required
aiAssistantsInt!Required
fieldDefinitionsInt!Required
fieldValuesInt!Required
flowsInt!Required
cardsInt!Required
triggersInt!Required
flowVersionsInt!Required
flowActivitiesInt!Required
flowTemplatesInt!Required
flowWaitsInt!Required
flowDelaysInt!Required
flowDispatchesInt!Required
whatsappTemplatesInt!Required
webIntegrationsInt!Required
webVisitorPasskeysInt!Required
helpArticlesInt!Required
helpFoldersInt!Required
helpTagsInt!Required
helpSourcesInt!Required
newsPostsInt!Required
newsCategoriesInt!Required
newsTagsInt!Required
newsSourcesInt!Required
reactionSetsInt!Required
visitorReactionCountersInt!Required
webhookConnectionsInt!Required
webhookDeliveryLogsInt!Required
webhookInboundLogsInt!Required
crmSyncJobsInt!Required
ssoConfigsInt!Required
remindersInt!Required
knowledgeChunksInt!Required
aiRequestLogsInt!Required
peopleExportJobsInt!Required
mentionReceiptsInt!Required
metricsSnapshotsInt!Required
billingPeriodUsagesInt!Required
conversationsInt!Required

ClientOrgsFilterInput

Input fields

searchString

ClientOrgsPage

Fields

data[Organisation!]!Required
nextCursorString
hasNextBoolean!Required
totalCountInt
Total matching client orgs (only on first page)

CollectionChatCount

Fields

collectionIdString!Required
countFloat!Required

CollectionConversationCount

Fields

collectionIdString!Required
countFloat!Required

CollectionFilterField

Value
MESSAGE_LABEL
MESSAGE_TYPE
MESSAGE_TEXT
MESSAGE_DIRECTION
INTEGRATION_ID
ASSIGNED_TO
CHAT_UNREAD
CONTACT_NAME
CHAT_CREATED
PROFILE_FIELD

CollectionRule

Fields

fieldCollectionFilterField!Required
operatorFilterOperator!Required
valueJSON
Value to filter by. Not required for operators like IS_EMPTY, IS_NOT_EMPTY, EXISTS, NOT_EXISTS.
fieldPathString

CollectionRuleInput

Input fields

fieldCollectionFilterField!Required
operatorFilterOperator!Required
valueJSON
Value to filter by. Not required for operators like IS_EMPTY, IS_NOT_EMPTY, EXISTS, NOT_EXISTS.
fieldPathString

CommentWebhookStatus

Value
LIVE
NEEDS_RECONNECT
NEEDS_RESUBSCRIBE

ConnectWhatsAppChannelInput

Input fields

accessTokenString!Required
Meta (system-user / business) access token for the WABA
wabaIdString!Required
WhatsApp Business Account id
phoneNumberIdString!Required
Phone number id to connect
tokenExpiresInInt
Access-token lifetime in seconds (default ~60 days)

Contact

Fields

firstNameString!Required
Contact first name (required by Telegram)
lastNameString
Contact last name
phoneNumberString
Contact phone number
formattedNameString
Formatted display name (WhatsApp: formatted_name)
userIdInt
Telegram user ID (if known)
vcardString
Additional data in vCard format
middleNameString
Middle name
prefixString
Name prefix (Mr., Dr., etc.)
suffixString
Name suffix (Jr., III, etc.)
birthdayString
Birthday (YYYY-MM-DD format)
addresses[ContactAddress!]
Addresses
emails[ContactEmail!]
Email addresses
phones[ContactPhone!]
Phone numbers
orgContactOrg
Organization info
urls[ContactUrl!]
Website URLs

ContactAddress

Fields

streetString
cityString
stateString
zipString
countryString
countryCodeString
typeString
Address type: HOME, WORK

ContactApi

Fields

idID!Required
displayNameString
avatarUrlString
phoneString
emailString
channels[String!]!Required
erasedBoolean!Required
externalIdString

ContactApiChannelInput

Input fields

kindContactChannelKind!Required
phoneString
telegramIdString
viberUserIdString
integrationIdString

ContactApiFieldFilterInput

Input fields

keyString!Required
valueJSON!Required
string / number / boolean (exact match)

ContactApiFieldInput

Input fields

keyString!Required
valueJSON

ContactApiFilterInput

Input fields

searchString
externalIdString
phoneString
channelContactChannel
fields[ContactApiFieldFilterInput!]
createdAfterDateTime
createdBeforeDateTime

ContactApiPage

Fields

items[ContactApi!]!Required
nextCursorString
totalCountInt

ContactApiPaginationInput

Input fields

firstInt
afterID

ContactApiWriteInput

Input fields

externalIdString
displayNameString
firstNameString
lastNameString
phoneString
languageString
fields[ContactApiFieldInput!]
channelContactApiChannelInput

ContactChannel

Value
TELEGRAM
WHATSAPP
VIBER
INSTAGRAM
WEB

ContactChannelKind

Value
WHATSAPP
TELEGRAM
VIBER

ContactEmail

Fields

emailString!Required
typeString
Email type: HOME, WORK

ContactOrg

Fields

companyString
departmentString
titleString

ContactPhone

Fields

phoneString!Required
typeString
Phone type: CELL, MAIN, HOME, WORK
waIdString
WhatsApp ID if registered

ContactUrl

Fields

urlString!Required
typeString
URL type: HOME, WORK

Conversation

Fields

_idString!Required
createdAtDateTime!Required
updatedAtDateTime!Required
unReadCountInt
engagedBoolean
True once the conversation has real engagement (a visitor inbound message OR a human-operator message). false = captured/hidden from the operator inbox; absent/unset = visible (legacy rows + all non-web channels). Set explicitly, never defaulted.
lastMessageMessage
lastMessageAtDateTime
lastActivityAtDateTime
statusConversationStatus
threads[Chat!]!Required
primaryThreadChat!Required
analytics[PeopleFieldValue!]!Required
channels[ConversationChannel!]!Required
threadStatusConversationStatus
isBlockedBoolean!Required
The contact PERSON-level block flag (People IS_BLOCKED), not a single thread chat-level override. Drives the conversation-level block toggle label.
hasBlockedThreadBoolean!Required
True when ANY thread of the conversation is blocked (the thread UNION) - i.e. the conversation is a member of its org blocked collection. Drives the inbox row / conversation header block mark. Distinct from isBlocked (the person-level flag driving the block toggle, read from one representative thread).
assignedToUser
Rollup: the common operator across open threads, else null (see assignees).
assignees[User!]!Required
Distinct operators across the open threads (empty=none, 1=agree, several=diverge).
assignedStatusChatAssignmentStatus
Conversation-level connection state - PENDING when assignedTo set, else null; CONNECTED is per-thread-only.
channelGroups[ConversationChannelGroup!]!Required

ConversationChannel

Fields

integrationIdString!Required
providerIntegrationProvider!Required

ConversationChannelGroup

Fields

peoplePeople!Required
The channel identity - one People = one group.
providerIntegrationProvider!Required
integrationIdString
Integration behind the group; null if none.
threads[Chat!]!Required
This group's threads, capped at 20, lastActivity desc.
threadCountInt!Required
Total threads in the group (may exceed 20).
hasMoreThreadsBoolean!Required
isPrimaryBoolean!Required
The merge-kept / primary-thread People.
isMultiTopicBoolean!Required
Group has >1 thread (web multi-topic).
unreadCountInt!Required
lastActivityAtDateTime
Max thread activity in the group.

ConversationStatus

Value
OPEN
CLOSED

CreateChatCollectionInput

Input fields

nameString!Required
slugString
descriptionString
iconString
colorString
positionFloat
rules[CollectionRuleInput!]

CreateClientOrgInput

Input fields

nameString!Required
slugString
externalIdString
tenantDbUriString
tenantRedisUrlString

CreateCombinedMessageInput

Input fields

createdAtDateTime
deliveryStatusMessageDeliveryStatus
Delivery status - defaults based on message direction
replyToMessageString
mentions[ID!]
internalBoolean
Post as an internal note without a mention (team-only, never sent to the customer).
textString
buttons[MessageButtonInput!]
replyToButtonIdString
keyboardTypeString
flowTitleString
media[String!]
captionString
showCaptionAboveMediaBoolean
hasMediaSpoilerBoolean
mediaGroupIdString
isMediaGroupBoolean
mediaGroup[String!]

CreateFieldDefinitionDto

Input fields

keyString!Required
nameString!Required
typeString!Required
visibilityString
groupFieldGroup
Display section in the chat profile view (defaults to USER_DATA).
isRequiredBoolean
displayOrderFloat
pinnedToChatViewBoolean
Show this field in the compact chat panel (vs behind "See all"). Independent of group and visibility. Defaults to false.
descriptionString
options[String!]
defaultValueJSON
isSystemFieldBoolean
isReadOnlyBoolean
Whether this field is read-only. Read-only fields cannot be edited by users. This is typically set by the system for auto-calculated fields.

CreateHelpArticleInput

Input fields

integrationIds[ID!]
folderIdID
titleString!Required
slugString!Required
excerptString
contentString!Required
contentFormatHelpArticleContentFormat
localeString!Required
authorIds[ID!]
tagIds[ID!]
canonicalUrlString
coverImageUrlID
orderInt
knowledgeAudienceKnowledgeAudienceInput
Who the AI may answer from this item for (EVERYONE clears it)

CreateHelpFolderInput

Input fields

integrationIds[ID!]
nameString!Required
slugString!Required
descriptionString
parentIdID
orderInt

CreateHelpTagInput

Input fields

slugString!Required
labelString!Required
descriptionString

CreateLabelInput

Input fields

nameString!Required
descriptionString
colorString
activeBoolean

CreateMediaInput

Input fields

typeString!Required
filenameString
fileIdString
fileUniqueIdString
captionString
hasSpoilerBoolean
widthFloat
heightFloat
fileSizeFloat
durationFloat
supportsStreamingBoolean
disableContentTypeDetectionBoolean
performerString
titleString
mimeTypeString
thumbnailThumbnailInput
isAnimatedBoolean
isVideoBoolean
emojiString
setNameString
customEmojiIdString
stickerTypeString

CreateNewsCategoryInput

Input fields

slugString!Required
labelString!Required
descriptionString

CreateNewsPostInput

Input fields

integrationIds[ID!]
titleString!Required
slugString!Required
excerptString
contentMarkdownString!Required
localeString!Required
coverImageUrlID
audienceModeNewsAudienceMode
authorIds[ID!]
categoryIds[ID!]
tagIds[ID!]
knowledgeAudienceKnowledgeAudienceInput
Who the AI may answer from this item for (EVERYONE clears it)

CreateNewsTagInput

Input fields

slugString!Required
labelString!Required
descriptionString

CreateWebIntegrationInput

Input fields

nameString!Required
allowedOrigins[String!]!Required
aiAutoReplyModeAiAutoReplyMode!Required
aiAutoReplyAssistantIdID
aiAutoReplyRules[AiAutoReplyRuleInput!]

CreateWhatsAppTemplateInput

Input fields

integrationIdString!Required
Integration ID (WhatsApp Business Account)
nameString!Required
Template name (lowercase, alphanumeric, underscores only)
displayNameString
Human-readable display name
languageString!Required
Language code (e.g., en, en_US, es, de)
categoryWhatsAppTemplateCategory!Required
Template category
components[WhatsAppTemplateComponentInput!]!Required
Template components

CreateWhatsAppTemplateResult

Fields

successBoolean!Required
templateWhatsAppTemplate
errorString
externalTemplateIdString
External template ID from Meta

CursorPaginatedChat

Fields

previousCursorString
nextCursorString
hasPreviousBoolean!Required
hasNextBoolean!Required
data[Chat!]!Required

CursorPaginatedConversation

Fields

previousCursorString
nextCursorString
hasPreviousBoolean!Required
hasNextBoolean!Required
data[Conversation!]!Required

DeleteChatResult

Fields

messagesInt!Required
mediaInt!Required

DeleteWhatsAppTemplateResult

Fields

successBoolean!Required
errorString

EraseCount

Fields

collectionString!Required
The Mongo collection (or logical grouping) this count is for.
countInt!Required
How many documents in that collection were (or would be) affected.

EraseInput

Input fields

contactIdID!Required
The Contact to erase (or preview erasing).
organisationIdID!Required
The organisation the contact must belong to.
reasonString
Optional free-text reason/ticket reference for the erasure. Operator-supplied free text, passed through as-is.

ErasePreviewType

Fields

contactIdID!Required
The Contact this preview was computed for.
willErase[EraseCount!]!Required
Per-collection counts of documents an eraseContact call would affect.
warnings[String!]!Required
Human-readable, PII-free warning lines (e.g. 'contact already erased', 'N messages will be anonymized').

EraseResultType

Fields

contactIdID!Required
The Contact that was erased.
erasedAtDateTime!Required
When the erasure completed.
affectedCounts[EraseCount!]!Required
Per-collection counts of documents affected by the erasure.
erasureLogIdID!Required
The ErasureLog._id this erasure was recorded under.

FieldGroup

Value
IDENTITY
USER_DATA
CONVERSATION
BUSINESS
ANALYTICS

FieldType

Value
STRING
NUMBER
BOOLEAN
DATE
ARRAY

FieldVisibility

Value
PUBLIC
PRIVATE

FilterOperator

Value
EQUALS
NOT_EQUALS
IN
NOT_IN
CONTAINS_ANY
CONTAINS_ALL
CONTAINS
NOT_CONTAINS
STARTS_WITH
ENDS_WITH
REGEX
EXISTS
NOT_EXISTS
IS_EMPTY
IS_NOT_EMPTY
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
BETWEEN

FlowInitiator

Value
USER_TRIGGER
OPERATOR
WEBHOOK
FLOW_COMPLETED
TIMEOUT
SYSTEM

GameAnimation

Fields

fileIdString
Telegram file identifier
fileUniqueIdString
Unique file identifier
urlString
Animation URL (for display)
widthInt
Video width
heightInt
Video height
durationInt
Duration in seconds
fileNameString
Original animation filename
mimeTypeString
MIME type of the file
fileSizeInt
File size in bytes

GamePhoto

Fields

fileIdString
Telegram file identifier
fileUniqueIdString
Unique file identifier
urlString
Photo URL (for display)
widthInt
Photo width
heightInt
Photo height
fileSizeInt
File size in bytes

GetCursorPaginatedInput

Input fields

cursorString
limitInt
beforeBoolean

GetSortedInput

Input fields

sortByString!Required
sortOrderString!Required

HelpArticle

Fields

_idID!Required
organisationIdID!Required
integrationIds[ID!]!Required
folderHelpFolder
ancestors[ID!]!Required
titleString!Required
slugString!Required
excerptString
contentString!Required
contentFormatHelpArticleContentFormat!Required
localeString!Required
translationGroupIdID
authors[User!]!Required
tags[HelpTag!]!Required
statusHelpArticleStatus!Required
knowledgeAudienceKnowledgeAudience
Who the AI agent may answer from this article for (null = everyone). Does not change who can read it in the widget.
publishedAtDateTime
publishedByID
coverImageUrlMedia
orderInt!Required
viewCountInt!Required
reactionCountsJSON!Required
Per-slot reaction counts keyed by slotIndex (string). FE joins against reactionSet(HELP) for emoji + sentiment.
viewerReactionInt
The current visitor's own reaction slotIndex on this item (per translation group), or null if they haven't reacted / aren't identified.
canonicalUrlString
sourceHelpSource
externalIdString
upstreamUpdatedAtDateTime
sourceUrlString
createdAtDateTime!Required
updatedAtDateTime!Required
translations[HelpArticle!]!Required

HelpArticleContentFormat

Value
MARKDOWN
HTML

HelpArticleSort

Value
CREATED_DESC
ORDER_ASC
UPDATED_DESC
PUBLISHED_DESC
TITLE_ASC

HelpArticleStatus

Value
DRAFT
PUBLISHED

HelpFolder

Fields

_idID!Required
organisationIdID!Required
integrationIds[ID!]!Required
nameString!Required
slugString!Required
descriptionString
nameI18nJSON
descriptionI18nJSON
parentIdID
ancestors[ID!]!Required
orderInt!Required
createdAtDateTime!Required
updatedAtDateTime!Required
articleCountInt!Required
Total published articles in this folder + all nested subfolders. Computed via a single countDocuments against the ancestors index.

HelpFolderCounts

Fields

foldersInt!Required
articlesInt!Required

HelpFolderCountsEntry

Fields

folderIdID!Required
foldersInt!Required
articlesInt!Required

HelpRssSourceConfig

Fields

feedUrlString!Required
pollMinutesInt!Required
lastPolledAtDateTime
lastPollStatusString

HelpSource

Fields

_idID!Required
organisationIdID!Required
integrationIds[ID!]!Required
nameString!Required
typeHelpSourceMode!Required
rssHelpRssSourceConfig
webhookConnectionIdID
fieldMapHelpSourceFieldMap
enabledBoolean!Required
lastSampleItemJSON
lastSampleItems[JSON!]
lastSampleAtDateTime
createdAtDateTime!Required
updatedAtDateTime!Required

HelpSourceFieldMap

Fields

externalIdString
titleString
bodyString
bodyFormatString
excerptString
publishedAtString
updatedAtString
sourceUrlString
localeString
slugString
folderString
folderSlugFieldString
folderLabelFieldString
folderParentFieldString
folderDescriptionFieldString
folderAncestorsString
tagsString
tagsSlugFieldString
tagsLabelFieldString

HelpSourceMode

Value
RSS
WEBHOOK_PUSH

HelpTag

Fields

_idID!Required
organisationIdID!Required
slugString!Required
labelString!Required
labelI18nJSON
descriptionString
createdAtDateTime!Required
updatedAtDateTime!Required

HostedConnectChannel

Value
WHATSAPP
INSTAGRAM

InboxCounts

Fields

allInt!Required
mineInt!Required
mentionsInt!Required
perCollection[CollectionConversationCount!]!Required

Integration

Fields

createdAtDateTime!Required
updatedAtDateTime!Required
_idString!Required
categoryIntegrationCategory!Required
Integration category
providerIntegrationProvider
Integration provider (AI, Messaging, CRM)
nameString
Custom integration name (required for CUSTOM provider)
aiAutoReplyIntegrationAiAutoReply
Per-integration AI auto-reply config: whether a new contact gets AI enabled by default and which assistant. Seeded on the first message.
statusIntegrationStatus!Required
Integration connection status
errorIntegrationError
Structured error information if connection failed
organisationIdString!Required
Organization this integration belongs to
lastTestedAtDateTime
When the integration was last tested
disconnectedAtDateTime
When the integration was disconnected (token removed)
commentWebhookStatusCommentWebhookStatus
Whether this Instagram integration is set up to receive comment webhooks (LIVE / NEEDS_RECONNECT / NEEDS_RESUBSCRIBE). Derived from stored metadata only - never calls Meta on read. Use checkCommentWebhookConnection to refresh it against Meta on demand. Null for non-Instagram integrations.

IntegrationAiAutoReply

Fields

modeAiAutoReplyMode!Required
assistantIdID
rules[AiAutoReplyRule!]

IntegrationAiAutoReplyInput

Input fields

modeAiAutoReplyMode!Required
assistantIdID
Assistant to use when mode = SPECIFIC; fallback agent when mode = RULES.
rules[AiAutoReplyRuleInput!]
Ordered agent-selection rules (mode = RULES only).

IntegrationCategory

Value
AI
MESSAGING
INBOX
CRM
PAYMENTS
CALENDAR
CUSTOM

IntegrationCleanupResult

Fields

integrationIdString!Required
organisationIdString!Required
dryRunBoolean!Required
If true, this was a preview - no data was actually deleted
deletedPeopleInt!Required
Number of People (lead) records deleted (only if deletePeople=true)
deletedPeopleFieldValuesInt!Required
Number of PeopleFieldValue records deleted (only if deletePeople=true)
deletedChatsInt!Required
Number of Chat records deleted (always deleted on disconnect)
deletedMessagesInt!Required
Number of Message records deleted (always deleted on disconnect)
deletedMessageReactionsInt!Required
Number of MessageReaction records deleted (always deleted on disconnect)
deletedMediaInt!Required
Number of Media files deleted from S3 and database (always deleted on disconnect)
deletedCollectionsInt!Required
Number of ChatCollections deleted (collections with INTEGRATION_ID rules referencing this integration)
deletedTemplatesInt!Required
Number of WhatsApp templates deleted (only for WhatsApp integrations)
updatedFlowsInt!Required
Number of Flows updated (integration removed from integrationIds array)
errors[String!]!Required
Any errors that occurred during cleanup

IntegrationError

Fields

codeString!Required
Error code (e.g., "401", "TIMEOUT")
typeString!Required
Error type (e.g., "authentication_error", "network_error")
providerString
Provider that generated the error

IntegrationProvider

Value
OPENAI
ANTHROPIC
CUSTOM
TELEGRAM
WHATSAPP
VIBER
INSTAGRAM
WEB
BIGQUERY
HUBSPOT
SALESFORCE
STRIPE
GOOGLE_CALENDAR
CALENDLY
CAL_COM

IntegrationStatus

Value
CONNECTED
PENDING
FAILED
IDLE
PAUSED
DISCONNECTED

KnowledgeAudience

Fields

kindKnowledgeAudienceKind!Required
fieldKeyString
FIELD_VALUES only: the People field key, e.g. "plan".
values[String!]
FIELD_VALUES only: allowed values (case-insensitive), matched against the verified (JWT-signed / operator-verified) value.

KnowledgeAudienceInput

Input fields

kindKnowledgeAudienceKind!Required
fieldKeyString
values[String!]

KnowledgeAudienceKind

Value
EVERYONE
SIGNED_IN
FIELD_VALUES

Label

Fields

_idString!Required
nameString!Required
organisationIdString!Required
colorString!Required
activeBoolean!Required
archivedBoolean!Required
isSystemBoolean!Required
descriptionString
createdAtDateTime!Required
updatedAtDateTime!Required

LauncherPosition

Value
RIGHT_BOTTOM
LEFT_BOTTOM

Locale

Value
EN
DE
UK
IT
PT
PL

LoginUrlConfig

Fields

urlString!Required
HTTPS URL for user authorization
forwardTextString
Text of the button in forwarded messages
botUsernameString
Bot username for authorization
requestWriteAccessBoolean
Request permission to send messages to user

MPMActionInput

Input fields

thumbnailProductRetailerIdString!Required
Product SKU for the thumbnail image displayed in the message.
sections[MPMSectionInput!]!Required
Product sections. Max 10 sections, 30 products total across all sections.

MPMProductItemInput

Input fields

productRetailerIdString!Required
Product SKU/ID from Facebook Commerce Manager. Must exist in the connected catalog.

MPMSectionInput

Input fields

titleString!Required
Section title displayed above products. Max 24 characters.
productItems[MPMProductItemInput!]!Required
Products in this section. Total across all sections max 30.

Media

Fields

_idString!Required
urlString!Required
typeMediaType!Required
filenameString
widthFloat
heightFloat
fileSizeFloat
durationFloat
supportsStreamingBoolean
disableContentTypeDetectionBoolean
performerString
titleString
mimeTypeString
thumbnailThumbnail
frames[Thumbnail!]
isAnimatedBoolean
isVideoBoolean
emojiString
setNameString
customEmojiIdString
stickerTypeString
needsRepaintingBoolean
processedContentString
Processed/extracted text content for knowledge base
isProcessedBoolean
Whether file processing is complete for knowledge base
transcriptionMediaTranscription
Auto-generated audio transcription with timeline
scanStatusScanStatus
Malware scan status from AWS GuardDuty S3 Protection

MediaGroupMessage

Fields

_idString!Required
messageIdFloat
media[Media!]
mediaGroupIdString
isMediaGroupBoolean
captionString
showCaptionAboveMediaBoolean
hasMediaSpoilerBoolean
createdAtDateTime
updatedAtDateTime
isDeletedBoolean

MediaTranscription

Fields

textString!Required
languageString
durationFloat
segments[TranscriptionSegment!]
words[TranscriptionWord!]
transcribedAtDateTime!Required
translatedTranslatedTranscription

MediaType

Value
PHOTO
VIDEO
VIDEO_NOTE
DOCUMENT
AUDIO
VOICE
ANIMATION
STICKER

MediaTypeCount

Fields

typeMediaType!Required
countInt!Required

MentionReadStatus

Fields

totalInt!Required
readCountInt!Required
recipients[MentionRecipientStatus!]!Required

MentionRecipientStatus

Fields

userUser!Required
readAtDateTime

MergedInfo

Fields

integrationsIds[ID!]!Required
loosersIds[ID!]!Required
loosers[People!]!Required

Message

Fields

_idString!Required
messageIdFloat
externalMessageIdString
typeMessageType!Required
fromMessageSenderUnion
chatChat!Required
directionMessageDirection!Required
sentFromChannelBoolean
textString
mediaGroup[MediaGroupMessage!]
media[Media!]
captionString
showCaptionAboveMediaBoolean
hasMediaSpoilerBoolean
contactContact
locationMessageLocation
unsupportedMessageUnsupported
products[MessageProduct!]
pollMessagePoll
diceMessageDice
gameMessageGame
buttons[MessageButton!]
sources[MessageSource!]
replyToMessageMessage
replyToButtonIdString
repliedToCommentMessageRepliedToComment
keyboardTypeString
flowTitleString
templateIdString
templateTemplateInfo
systemSystemMessageInfo
reactions[MessageReaction!]!Required
labels[Label!]
mentions[User!]
createdAtDateTime
updatedAtDateTime
deletedByMessageSenderUnion
isDeletedBoolean
deliveryStatusMessageDeliveryStatus
deliveryStatusAtDateTime
errorMessageString
actionsMessageActions
aiSkillsExecutionIdString
AISkillsExecution._id when this message was produced by an AI Skills run. Drives the "AI" visibility badge on the chat thread and the dashboard drill-down.
errorCodeString
authorMessageAuthor
mentionReadStatusMentionReadStatus
Per-recipient read aggregate for an INTERNAL_NOTE. Null for non-internal messages or soft-deleted notes. Surface "Read by Alice ✓ / Bob unread" inline in the chat thread.

MessageActions

Fields

buttons[ActionButton!]!Required
contextActionContext
answeredButtonIdString
answeredByUser
answeredAtDateTime

MessageAuthor

Fields

participantIdID!Required
contactIdID
peopleIdID
roleString
displayPeople

MessageButton

Fields

labelString!Required
Button text/label
typeString!Required
Button type (see ButtonType enum)
buttonIdString
Unique button identifier
callbackDataString
Callback data (for callback buttons)
urlString
URL to open (for url buttons)
webAppWebAppConfig
Web App config (for web_app buttons)
loginUrlLoginUrlConfig
Login URL config (for login buttons)
switchInlineQueryString
Inline query for switch_inline buttons
switchInlineQueryCurrentChatString
Inline query for switch_inline_current buttons
switchInlineQueryChosenChatSwitchInlineQueryChosenChatConfig
Config for switch_inline_chosen buttons
callbackGameBoolean
True for game buttons
payBoolean
True for pay buttons
requestUsersRequestUsersConfig
Request users config
requestChatRequestChatConfig
Request chat config
requestContactBoolean
True to request user contact
requestLocationBoolean
True to request user location
requestPollRequestPollConfig
Request poll config
waButtonIdString
WhatsApp button ID (for quick_reply)
phoneNumberString
Phone number (for phone_number buttons)
valueString
Legacy: callback data or value

MessageButtonInput

Input fields

labelString!Required
typeString!Required
buttonIdString
callbackDataString
urlString
webAppUrlString
loginUrlUrlString
loginUrlForwardTextString
loginUrlBotUsernameString
loginUrlRequestWriteAccessBoolean
switchInlineQueryString
switchInlineQueryCurrentChatString
callbackGameBoolean
payBoolean
requestContactBoolean
requestLocationBoolean
waButtonIdString
phoneNumberString
valueString

MessageDeliveryStatus

Value
PENDING
SENT
DELIVERED
READ
FAILED

MessageDice

Fields

emojiString!Required
Emoji on which the dice throw animation is based
valueInt!Required
Value of the dice. 1-6 for 🎲🎯🎳, 1-5 for 🏀⚽, 1-64 for 🎰

MessageDirection

Value
INBOUND
OUTBOUND

MessageGame

Fields

titleString!Required
Title of the game
descriptionString!Required
Description of the game
photo[GamePhoto!]
Photo that will be displayed in the game message in chats
textString
Brief description of the game or high scores (0-4096 characters)
shortNameString
Short name of the game used for launching
animationGameAnimation
Animation that will be displayed in the game message

MessageLocation

Fields

latitudeFloat!Required
Latitude coordinate
longitudeFloat!Required
Longitude coordinate
titleString
Venue title / Location name (WhatsApp: name, Telegram Venue: title)
addressString
Venue/Location address
foursquareIdString
Foursquare identifier of the venue (Telegram)
foursquareTypeString
Foursquare type of the venue (Telegram)
googlePlaceIdString
Google Places identifier (Telegram)
googlePlaceTypeString
Google Places type (Telegram)
horizontalAccuracyFloat
The radius of uncertainty for the location, measured in meters; 0-1500
livePeriodInt
Period in seconds for which the location can be updated (live location)
headingInt
The direction in which user is moving, in degrees; 1-360
proximityAlertRadiusInt
Maximum distance in meters for proximity alerts about approaching another chat member
isVenueBoolean
True if this is a venue (has title/address)

MessageOrgSender

Fields

idString!Required
nameString
logoString
Logo image URL
kindOrganisationKind

MessagePoll

Fields

idString
Unique poll identifier
questionString!Required
Poll question, 1-300 characters
options[PollOption!]!Required
List of poll options
totalVoterCountFloat
Total number of voters
isClosedBoolean
True if the poll is closed
isAnonymousBoolean
True if poll votes are anonymous
typeString
Poll type: "regular" or "quiz"
allowsMultipleAnswersBoolean
True if multiple answers allowed
correctOptionIdInt
Index of correct answer (quiz mode)
explanationString
Explanation for correct answer (quiz mode)
closeDateInt
Poll close time (Unix timestamp)
openPeriodInt
Amount of time in seconds the poll will be active after creation

MessageProduct

Fields

providerString!Required
Product provider - e.g. WHATSAPP. Generic for future providers.
catalogIdString
Catalog the product belongs to (provider catalog id).
productRetailerIdString
Provider retailer id (SKU). Absent for a bare catalog reference (catalog_message with no specific product).
nameString
Product name, enriched from the catalog.
imageUrlString
Product image URL, enriched from the catalog.
priceFloat
Structured unit price (INBOUND order webhook - clean number + currency).
currencyString
ISO currency code for price (e.g. USD).
priceLabelString
Display-ready formatted price from the catalog (e.g. '132,00 $') for OUTBOUND product/catalog items. The catalog only exposes a formatted string (no clean number + ISO split), so it is passed through verbatim. Render this as-is when present; INBOUND orders use price + currency.
quantityInt
Ordered quantity. Set for INBOUND orders only.

MessageReaction

Fields

_idString!Required
messageIdString!Required
users[ReactionUser!]
typeReactionType!Required
emojiString
customEmojiIdString
urlString
countInt!Required
createdAtDateTime!Required
updatedAtDateTime!Required

MessageReactionInput

Input fields

fromString
fromModelString!Required
typeReactionType!Required
emojiString
customEmojiIdString
urlString

MessageRepliedToComment

Fields

idID!Required
postIdID!Required
textString!Required
permalinkString

MessageSource

Fields

linkString
seoTitleString
seoDescriptionString

MessageType

Value
TEXT
BUTTONS
MEDIA
MEDIA_BUTTONS
MEDIA_GROUP
LOCATION
POOL
CONTACT
PIN
GAME
DICE
CHAT_UPDATE
STORY
UNKNOWN
UNSUPPORTED
LIST
TEMPLATE
CALLBACK
CTA_URL
LOCATION_REQUEST
ORDER
PRODUCT
SYSTEM
INTERNAL_NOTE
INTERNAL_ACTIONS

MessageUnsupported

Fields

reasonUnsupportedReason!Required
providerTypeString

ModelCapability

Value
CHAT
TEXT_GENERATION
REASONING
IMAGE_GENERATION
IMAGE_EDITING
IMAGE_INPUT
AUDIO_GENERATION
AUDIO_INPUT
TRANSCRIPTION
TTS
SEARCH
CODE_GENERATION

ModelInfo

Fields

idString!Required
Unique model identifier
categoryIntegrationProvider!Required
AI provider/category
nameString!Required
Display name for the model
createdFloat
Unix timestamp when model was created
ownedByString
Organization that owns the model
isCustomBoolean
Whether this is a custom model
capabilities[ModelCapability!]
Model capabilities
contextWindowFloat
Context window size
descriptionString
Model description
costMultiplierInt!Required
Cost multiplier for AI operations (1=haiku, 2=sonnet/older-opus, 3=opus-4.7, 4=opus-4.8, 5=fable)

ModelSlots

Fields

imageModelInfo
Model for image generation and editing (e.g. dall-e-3, gpt-image-1)
ttsModelInfo
Model for text-to-speech (e.g. tts-1, gpt-4o-mini-tts)
transcriptionModelInfo
Model for speech-to-text transcription (e.g. whisper-1)
visionModelInfo
Model for vision/image analysis. Overrides system vision fallback.

MoveCollectionInput

Input fields

collectionIdOrSlugString!Required
Collection ID or slug
newPositionFloat!Required
Target position value. System collections: 0, 1, 2... User collections: 100, 101, 102...

NewsAudienceMode

Value
ALL
AUTHED

NewsCategory

Fields

_idID!Required
organisationIdID!Required
slugString!Required
labelString!Required
labelI18nJSON
descriptionString
createdAtDateTime!Required
updatedAtDateTime!Required

NewsPost

Fields

_idID!Required
organisationIdID!Required
integrationIds[ID!]!Required
titleString!Required
slugString
excerptString
contentMarkdownString!Required
bodyFormatString!Required
localeString!Required
translationGroupIdID
statusNewsPostStatus!Required
publishedAtDateTime
publishedByID
coverImageUrlMedia
externalCoverImageUrlString
archivedAtDateTime
scheduledForDateTime
viewCountInt!Required
reactionCountsJSON!Required
Per-slot reaction counts keyed by slotIndex (string). FE joins against reactionSet(NEWS) for emoji + sentiment.
viewerReactionInt
The current visitor's own reaction slotIndex on this item (per translation group), or null if they haven't reacted / aren't identified.
audienceModeNewsAudienceMode!Required
knowledgeAudienceKnowledgeAudience
Who the AI agent may answer from this post for (null = everyone; an AUTHED post is always at least signed-in). Does not change who can read it in the widget.
sourceNewsSource
externalIdString
sourceUrlString
categories[NewsCategory!]!Required
tags[NewsTag!]!Required
authors[User!]!Required
upstreamUpdatedAtDateTime
createdAtDateTime!Required
updatedAtDateTime!Required
translations[NewsPost!]!Required

NewsPostSort

Value
CREATED_DESC
UPDATED_DESC
PUBLISHED_DESC

NewsPostStatus

Value
DRAFT
SCHEDULED
PUBLISHED
ARCHIVED

NewsSource

Fields

_idID!Required
organisationIdID!Required
integrationIds[ID!]!Required
nameString!Required
typeNewsSourceMode!Required
rssRssSourceConfig
webhookConnectionIdID
fieldMapNewsSourceFieldMap
enabledBoolean!Required
lastSampleItemJSON
lastSampleItems[JSON!]
lastSampleAtDateTime
createdAtDateTime!Required
updatedAtDateTime!Required

NewsSourceFieldMap

Fields

externalIdString
titleString
bodyString
bodyFormatString
excerptString
publishedAtString
updatedAtString
sourceUrlString
localeString
coverImageUrlString
slugString
audienceModeString
categoriesString
tagsString
tagsSlugFieldString
tagsLabelFieldString
categoriesSlugFieldString
categoriesLabelFieldString

NewsSourceMode

Value
NATIVE
RSS
WEBHOOK_PUSH

NewsTag

Fields

_idID!Required
organisationIdID!Required
slugString!Required
labelString!Required
labelI18nJSON
descriptionString
createdAtDateTime!Required
updatedAtDateTime!Required

OrgTeamMember

Fields

idString!Required
userIdString
emailString
roleRole!Required
statusOrganisationMemberStatus!Required

Organisation

Fields

_idString!Required
nameString!Required
slugString!Required
partnerOfString
partnerRelationPartnerRelation
externalIdString
kindOrganisationKind!Required
tenantConnectionTenantConnectionStatus
Last known health of the dedicated database/Redis; null when the org uses shared infra

OrganisationCleanupResult

Fields

successBoolean!Required
organisationIdString!Required
deletedCountsCleanupDeletedCounts!Required
errors[String!]!Required
durationInt!Required
Duration in milliseconds

OrganisationKind

Value
MASTER
SYSTEM
PARTNERSHIP
TECH_PROVIDER
DEFAULT

OrganisationMemberStatus

Value
PENDING
ACCEPTED
DECLINED
REMOVED

OutboundWebhookEventName

Value
CHAT_CREATED
CHAT_UPDATED
CHAT_DELETED
MESSAGE_INBOUND_CREATED
MESSAGE_INBOUND_UPDATED
MESSAGE_INBOUND_DELETED
MESSAGE_OUTBOUND_CREATED
MESSAGE_OUTBOUND_UPDATED
MESSAGE_OUTBOUND_DELETED
MESSAGE_OUTBOUND_STATUS
CONTACT_CREATED
CONTACT_UPDATED
CONTACT_DELETED
CONTACT_MERGED
CONTACT_SPLIT
CONVERSATION_CREATED
CONVERSATION_UPDATED
COMMENT_CREATED
COMMENT_UPDATED
COMMENT_DELETED
POST_CREATED
POST_DELETED
ORGANISATION_DELETED
FLOW

PaginateMessagesInput

Input fields

cursorString
isBeforeBoolean
limitInt!Required

PaginatedHelpArticles

Fields

items[HelpArticle!]!Required
List of items for current page
metaPaginationMeta!Required
Pagination metadata

PaginatedMessages

Fields

data[Message!]!Required
nextCursorString
previousCursorString
hasNextBoolean!Required
hasPreviousBoolean!Required
unreadCountFloat
totalMessagesFloat
Total count of messages matching the query (only for search)
totalChatsFloat
Total count of chats matching the filters (only for search)

PaginatedNewsPosts

Fields

items[NewsPost!]!Required
List of items for current page
metaPaginationMeta!Required
Pagination metadata

PaginationMeta

Fields

totalCountFloat!Required
Total number of items
currentPageFloat!Required
Current page number
totalPagesFloat!Required
Total number of pages
hasNextPageBoolean!Required
Whether there is a next page
hasPreviousPageBoolean!Required
Whether there is a previous page

PartnerDeleteConversationResult

Fields

chatsInt!Required
messagesInt!Required
mediaInt!Required
contactsErasedInt!Required
Contacts anonymised everywhere (GDPR erase, ErasureLog) by removePeople:true. Not a hard delete of the person.

PartnerRelation

Value
REFERRED
MANAGED

PartnerUsageSummary

Fields

childrenInt!Required
opsUnitsInt!Required
aiUnitsInt!Required
estimatedAmountCentsInt!Required
currencyString!Required
opsAllowanceRemainingFloat!Required
aiAllowanceRemainingFloat!Required
currentPeriodStartDateTime!Required
currentPeriodEndDateTime!Required

PartnerWebhookOutput

Fields

idID!Required
urlString!Required
subscribedEvents[OutboundWebhookEventName!]!Required
statusPartnerWebhookStatus!Required
createdAtDateTime
updatedAtDateTime

PartnerWebhookStatus

Value
ACTIVE
PAUSED

People

Fields

_idString!Required
createdAtDateTime!Required
updatedAtDateTime!Required
phoneNumberString
whatsappIdString
viberUserIdString
instagramUserIdString
visitorIdString
externalUserIdString
contactIdID
mergedMergedInfo
isAnonymousBoolean
authMethodAuthMethod
firstAuthenticatedAtDateTime
displayNameString
shortHandleString
usernameString
photoString
firstNameString
lastNameString
languageString
isBotBoolean
organisationString
integrationIdString
crmImportedFromString
crmRecordIdsJSON
crmSyncHistoryJSON
crmImportedAtDateTime
chatIdString
identifiedPinnedFields[String!]
webPreferencesJSON
engagedBoolean
contactIdentityCountInt!Required

PeopleFieldDefinition

Fields

_idString!Required
organisationIdString!Required
keyString!Required
nameString!Required
typeFieldType!Required
descriptionString
visibilityFieldVisibility!Required
groupFieldGroup
isRequiredBoolean!Required
isSystemFieldBoolean!Required
isReadOnlyBoolean!Required
Whether this field is read-only and cannot be edited by users. Read-only fields are auto-calculated or set by the system.
options[String!]
defaultValueJSON
displayOrderFloat!Required
pinnedToChatViewBoolean
createdAtDateTime!Required
updatedAtDateTime!Required

PeopleFieldValue

Fields

_idString!Required
peopleIdString!Required
organisationIdString!Required
fieldPeopleFieldDefinition!Required
valueJSON
createdAtDateTime!Required
updatedAtDateTime!Required
fieldKeyString

PeopleFieldsFilterDto

Input fields

peopleIdString
keys[String!]
typeString
visibilityString
groups[FieldGroup!]
Return only fields in these display groups - lets the chat view load the primary sections up front and the rest behind "Details".
onlyPinnedBoolean
Return only fields pinned to the compact chat panel - the fast query the chat view uses before the operator opens full "Details".
includeSystemFieldsBoolean
includeCustomFieldsBoolean
applyPrivacyMaskingBoolean

PollOption

Fields

textString!Required
Option text
voterCountInt
Number of voters (if visible)

PrechatFieldKind

Value
NAME
EMAIL
PHONE
CUSTOM_TEXT

PrechatFormField

Fields

kindPrechatFieldKind!Required
keyString!Required
labelString!Required
requiredBoolean!Required

PresenceStatus

Value
ONLINE
OFFLINE

PresetStatusType

Value
IN_MEETING
COMMUTING
OUT_SICK
VACATIONING
WORKING_REMOTELY
CUSTOM

Priority

Value
LOW
MEDIUM
HIGH
URGENT

ProductCarouselCardOverride

Input fields

cardIndexInt!Required
Card index (0-based)
productRetailerIdString!Required
Product SKU/ID from Facebook Commerce Manager for this card.

ProductTemplateOverrides

Input fields

spmHeaderSPMHeaderInput
For SPM templates: product header with retailer ID and catalog ID.
mpmActionMPMActionInput
For MPM templates: action with thumbnail product and sections.
carouselCards[ProductCarouselCardOverride!]
For Product Card Carousel: product overrides for each card.
catalogActionCatalogActionInput
For CATALOG templates: optional thumbnail product. Overrides template default.

ReactionType

Value
EMOJI
CUSTOM_EMOJI

ReactionUser

Fields

fromMessageSenderUnion
fromModelString!Required
reactedAtDateTime!Required

RegisteredPartnerWebhook

Fields

idID!Required
signingSecretString!Required

RequestChatConfig

Fields

requestIdInt!Required
Unique request identifier
chatIsChannelBoolean!Required
True to request a channel, false for group/supergroup
chatIsForumBoolean
True to request forum supergroup
chatHasUsernameBoolean
True to request supergroup/channel with username
chatIsCreatedBoolean
True to request chat owned by user
botIsMemberBoolean
True to request chat with bot as member

RequestPollConfig

Fields

typeString
Poll type: "quiz" or "regular"

RequestUsersConfig

Fields

requestIdInt!Required
Unique request identifier
userIsBotBoolean
True to request bots, false for regular users
userIsPremiumBoolean
True to request premium users
maxQuantityInt
Max number of users to select (1-10)

Role

Value
OWNER
ADMIN
EDITOR
AGENT

RotatedPartnerWebhookSecret

Fields

signingSecretString!Required

RssSourceConfig

Fields

feedUrlString!Required
pollMinutesInt!Required
lastPolledAtDateTime
lastPollStatusString

SPMHeaderInput

Input fields

productRetailerIdString!Required
Product SKU/ID from Facebook Commerce Manager. Product image is used as header.

ScanStatus

Value
PENDING
CLEAN
INFECTED
SKIPPED
ERROR

SearchChatsInput

Input fields

collectionIdOrSlugString
Filter by collection ID or slug to search within matching chats
rules[CollectionRuleInput!]
Filter by rules (for preview before saving a collection). Combined with collection rules if collectionIdOrSlug is also provided.

SearchChatsResult

Fields

data[Chat!]!Required
previousCursorString
nextCursorString
hasPreviousBoolean!Required
hasNextBoolean!Required
totalCountInt
Total count of chats matching the filters (only on first page)

SearchConversationsResult

Fields

data[Conversation!]!Required
previousCursorString
nextCursorString
hasPreviousBoolean!Required
hasNextBoolean!Required
totalCountInt
Total count of conversations matching the filters (only on first page)

SearchMessagesInput

Input fields

chatIdString
Filter by specific chat ID
collectionIdOrSlugString
Filter by collection ID or slug to search within matching chats
rules[CollectionRuleInput!]
Filter by rules (for preview before saving a collection). Takes precedence over collectionIdOrSlug.
conversationIdString
Filter to all threads of this conversation

SendWhatsAppTemplateInput

Input fields

templateIdString!Required
Template ID to send
chatIdString!Required
Chat ID to send the template to
variableOverridesTemplateVariableOverrides
Manual variable values to override auto-resolved values
productOverridesProductTemplateOverrides
Product-specific overrides for SPM, MPM, and Product Card Carousel templates. Required for catalog-based templates.

SendWhatsAppTemplateResult

Fields

successBoolean!Required
messageIdString
WhatsApp message ID if successful
errorString

SetFieldValueDto

Input fields

peopleIdString!Required
fieldIdString!Required
valueJSON

SetMessageLabelsInput

Input fields

messageIdString!Required
labelIds[String!]!Required

SetTelegramBotCommandsInput

Input fields

integrationIdString!Required
Integration ID
commands[TelegramBotCommandInput!]!Required
Commands to set (max 100)

SetTelegramBotDescriptionInput

Input fields

integrationIdString!Required
Integration ID
descriptionString!Required
Bot description (up to 512 chars, empty to clear)

SetTelegramBotNameInput

Input fields

integrationIdString!Required
Integration ID
nameString!Required
Bot name (up to 64 chars, empty to reset to username)

SetTelegramBotShortDescriptionInput

Input fields

integrationIdString!Required
Integration ID
shortDescriptionString!Required
Short description for profile page (up to 120 chars, empty to clear)

SetTelegramMenuButtonInput

Input fields

integrationIdString!Required
Integration ID
menuButtonTelegramMenuButtonInput!Required
Menu button to set

SocialPaginationInput

Input fields

cursorString
limitInt!Required

SortDirection

Value
ASC
DESC

SortOrder

Value
ASC
DESC

SpamBlockInitiator

Value
SYSTEM
OPERATOR

SpamBlockMode

Value
THROTTLE_ONLY
BLOCK_TEMP
BLOCK_FOREVER

StatusMessage

Fields

emojiString
textString
typePresetStatusType!Required
expiresAtDateTime

SwitchInlineQueryChosenChatConfig

Fields

queryString
Default inline query to insert
allowUserChatsBoolean
Allow private chats with users
allowBotChatsBoolean
Allow private chats with bots
allowGroupChatsBoolean
Allow group and supergroup chats
allowChannelChatsBoolean
Allow channel chats

SystemAssignInfo

Fields

assignedToUser
Operator the chat was assigned to
previousOperatorUser
Previous operator (for reassignment)
initiatorAssignmentInitiator!Required
Who initiated the assignment
assignedByUser
Operator who performed the manual assignment (when initiator is OPERATOR)

SystemFlowInfo

Fields

flowIdString!Required
Flow MongoDB ID
flowTitleString!Required
Human-readable flow title
executionIdString
Execution context ID
initiatorFlowInitiator
Who initiated or terminated the flow
operatorUser
Operator who started/stopped the flow (when initiator is OPERATOR)

SystemLoginInfo

Fields

userIdFloat!Required
Telegram user ID
firstNameString!Required
First name of the user
lastNameString
usernameString
photoUrlString
User photo URL
domainString
Domain the user logged in from

SystemMessageInfo

Fields

typeSystemMessageType!Required
System event type
loginSystemLoginInfo
Login details (for LOGIN type)
contacts[Chat!]
Shared user chats (for USERS_SHARED type)
chatChat
Shared chat (for CHAT_SHARED type)
messageMessage
Referenced message (for PIN/UNPIN types)
flowSystemFlowInfo
Flow details (for FLOW_STARTED, FLOW_COMPLETED, FLOW_TIMEOUT, FLOW_LOOP_DETECTED types)
assignSystemAssignInfo
Assignment details (for CHAT_ASSIGNED, CHAT_UNASSIGNED types)
statusChangeSystemStatusChangeInfo
Status change details (for CHAT_CLOSED, CHAT_REOPENED types)
spamSystemSpamInfo
Spam protection details (for USER_SPAM_BLOCKED, USER_SPAM_UNBLOCKED, OUTBOUND_PAUSED, OUTBOUND_RESUMED)

SystemMessageType

Value
LOGIN
USERS_SHARED
CHAT_SHARED
PIN
UNPIN
FLOW_STARTED
FLOW_COMPLETED
FLOW_TIMEOUT
FLOW_CANCELLED
SUB_FLOW_STARTED
SUB_FLOW_COMPLETED
SUB_FLOW_TIMEOUT
SUB_FLOW_CANCELLED
CONTACT_CREATED
CHAT_ASSIGNED
OPERATOR_CONNECTED
CHAT_RESOLVED
CHAT_UNASSIGNED
CHAT_CLOSED
CHAT_REOPENED
CHAT_STATUS_CHANGED
USER_SPAM_BLOCKED
USER_SPAM_UNBLOCKED
OUTBOUND_PAUSED
OUTBOUND_RESUMED
FLOW_LOOP_DETECTED

SystemSpamInfo

Fields

reasonString!Required
Human-readable reason for the spam event
initiatorSpamBlockInitiator!Required
Who triggered the action: SYSTEM (automatic) or OPERATOR (manual)
blockModeSpamBlockMode
Block mode at the time of the event (for blocked events)
blockDurationMinutesFloat
Block duration in minutes (for BLOCK_TEMP)
scopeBlockScope
Scope of the block/unblock: THREAD (this channel-thread only) or CONTACT (the whole person, every thread). Lets the transcript word a person-level block as "on all channels" vs a single-thread block.
blockedAtDateTime
When the spam action was triggered
operatorUser
Operator who manually blocked/unblocked/resumed (when initiator is OPERATOR)

SystemStatusChangeInfo

Fields

previousStatusString!Required
Previous ChatStatus value
newStatusString!Required
New ChatStatus value
initiatorAssignmentInitiator!Required
Who initiated the status change (SYSTEM or OPERATOR)
changedByUser
Operator who changed the status (when initiator is OPERATOR)

TechProviderAllTime

Fields

opsUsedFloat!Required
Ops used across all historical billing periods plus the live current period.
aiUsedFloat!Required
AI units used across all historical billing periods plus the live current period (may be fractional).
estimatedAmountCentsInt!Required
ESTIMATE only: all-time usage x the CURRENT contract rates (gross; ignores included allowances and the monthly minimum). There is no per-charge money log, so past rate changes are not reflected.

TechProviderChildUsagePage

Fields

data[TechProviderChildUsageRow!]!Required
nextCursorString
hasNextBoolean!Required
totalCountInt
Total matching client orgs (only on first page)

TechProviderChildUsageRow

Fields

organisationIdString!Required
nameString!Required
opsUsedFloat!Required
aiUsedFloat!Required
estimatedAmountCentsInt!Required

TechProviderMonthlyUsage

Fields

periodEndDateTime!Required
opsUsedFloat!Required
aiUsedFloat!Required
childrenInt!Required
estimatedAmountCentsInt!Required

TechProviderUsageFilterInput

Input fields

monthsInt
searchString

TelegramBotCommand

Fields

commandString!Required
Command name without the leading slash (e.g. "start")
descriptionString!Required
Command description (1-256 chars)

TelegramBotCommandInput

Input fields

commandString!Required
Command name: 1-32 lowercase latin letters, digits or underscores
descriptionString!Required
Command description: 1-256 characters

TelegramBotSettings

Fields

nameString!Required
Bot display name
descriptionString!Required
Bot description (shown on empty chat screen, up to 512 chars)
shortDescriptionString!Required
Short description (profile page, up to 120 chars)
commands[TelegramBotCommand!]!Required
Bot commands list
menuButtonTelegramMenuButton!Required
Chat menu button configuration
syncedAtString!Required
ISO timestamp of last sync from Telegram API

TelegramMenuButton

Fields

typeTelegramMenuButtonType!Required
Menu button type
textString
Button text (only for web_app type)
webAppUrlString
Mini App URL (only for web_app type)

TelegramMenuButtonInput

Input fields

typeTelegramMenuButtonType!Required
Menu button type
textString
Button text (required for web_app)
webAppUrlString
Mini App URL (required for web_app, must be HTTPS)

TelegramMenuButtonType

Value
DEFAULT
COMMANDS
WEB_APP

TemplateCardButton

Fields

labelString!Required
Button text/label
typeString!Required
Button type: url, quick_reply, phone_number, copy_code
valueString
URL or phone number value

TemplateCardPreview

Fields

cardIndexInt!Required
Card index (0-9)
headerFormatString
Header format: IMAGE, VIDEO, PRODUCT
bodyTextString
Body text with variables resolved
mediaMedia
Header media for this card (IMAGE or VIDEO)
buttons[TemplateCardButton!]
Buttons on this card
buttonCountInt
Number of buttons on card

TemplateInfo

Fields

headerTextString
Header text (for TEXT headers)
headerFormatString
Header format: TEXT, IMAGE, VIDEO, DOCUMENT, LOCATION, PRODUCT
footerTextString
Footer text
categoryString
Template category: MARKETING, UTILITY, AUTHENTICATION
locationTemplateLocationInfo
Location data for LOCATION header format
productRetailerIdString
Product SKU for PRODUCT header
catalogIdString
Catalog ID for product
ltoInfoTemplateLtoInfo
Limited-Time Offer info (countdown timer)
cards[TemplateCardPreview!]
Carousel cards preview (2-10 cards)
cardCountInt
Total number of carousel cards
usesCatalogBoolean
Whether this template uses catalog products (MPM/SPM)

TemplateLocationInfo

Fields

latitudeFloat!Required
Latitude coordinate
longitudeFloat!Required
Longitude coordinate
nameString
Location name
addressString
Street address

TemplateLtoInfo

Fields

hasExpirationBoolean!Required
Whether the LTO component is present
expirationTimeMsFloat
Expiration timestamp (ms) when sent
expirationTextString
Formatted expiration date/time

TemplateVariableOverrides

Input fields

header[String!]
Header variable values ({{1}} for text headers). For media headers, use headerMediaId instead.
headerMediaIdString
Media ID for IMAGE/VIDEO/DOCUMENT headers. Overrides the template defaultMedia. Must be a valid Media document ID.
body[String!]
Body variable values in order: {{1}}, {{2}}, {{3}}, etc.
buttons[String!]
Button variable values (e.g., URL suffix for dynamic URL buttons)
carouselCards[CarouselCardOverride!]
Overrides for carousel template cards. Each card can have its own header media and body variables.
expirationTimeMsFloat
Expiration timestamp (Unix ms) for LIMITED_TIME_OFFER templates. Required when the template has a countdown timer (hasExpiration: true).

TenantConnectionStatus

Fields

databaseTenantDatabaseStatus!Required
redisTenantRedisStatus!Required
checkedAtDateTime
When health was last recorded (null = not checked yet)
reasonString
Generic failure code, e.g. CONNECTION_FAILED

TenantDatabaseStatus

Value
SHARED
CONNECTED
DISCONNECTED

TenantRedisStatus

Value
SHARED
CONNECTED
DISCONNECTED

ThreadFilter

Value
ALL
UNRESOLVED
AWAITING_REPLY

ThreadsPage

Fields

threads[Chat!]!Required
nextCursorString
Opaque cursor for the next page; absent when this is the last page.
hasNextBoolean!Required

Thumbnail

Fields

urlString
fileIdString
fileUniqueIdString
fileSizeFloat
widthFloat
heightFloat

ThumbnailInput

Input fields

urlString
fileIdString
fileUniqueIdString
fileSizeFloat
widthFloat
heightFloat

TranscriptionSegment

Fields

startFloat!Required
endFloat!Required
textString!Required

TranscriptionWord

Fields

startFloat!Required
endFloat!Required
wordString!Required

TranslatedTranscription

Fields

textString!Required
languageString
segments[TranscriptionSegment!]
words[TranscriptionWord!]
translatedAtDateTime!Required

UnsupportedReason

Value
UNSUPPORTED_TYPE
UNSUPPORTED_ATTACHMENT

UpdateChannelInput

Input fields

nameString
Display name of the channel
aiAutoReplyIntegrationAiAutoReplyInput
AI auto-reply default for NEW contacts on this channel (SPECIFIC needs an assistant of the same organisation).

UpdateChatCollectionInput

Input fields

nameString
slugString
descriptionString
iconString
colorString
isVisibleBoolean
rules[CollectionRuleInput!]

UpdateChatFieldInput

Input fields

chatIdString!Required
fieldChatFieldKey!Required
valueJSON
Value can be string, number, boolean, or null
blockScopeBlockScope
2-level scope for field: IS_BLOCKED or AI_AVAILABLE. CONTACT (default) applies to every thread of the contact; THREAD applies to only this chat.

UpdateFieldDefinitionDto

Input fields

keyString
nameString
typeString
visibilityString
isRequiredBoolean
displayOrderFloat
groupFieldGroup
Move this field to another display section. Allowed on system fields (it is presentation, not data).
pinnedToChatViewBoolean
Pin/unpin this field in the compact chat panel. Allowed on system fields (presentation, not data).
descriptionString
options[String!]
defaultValueJSON

UpdateHelpArticleInput

Input fields

integrationIds[ID!]
folderIdID
titleString
slugString
excerptString
contentString
contentFormatHelpArticleContentFormat
localeString
authorIds[ID!]
tagIds[ID!]
canonicalUrlString
coverImageUrlID
orderInt
knowledgeAudienceKnowledgeAudienceInput
Who the AI may answer from this item for (EVERYONE clears it)

UpdateHelpFolderInput

Input fields

integrationIds[ID!]
nameString
slugString
descriptionString
orderInt
nameI18nJSON
descriptionI18nJSON

UpdateHelpTagInput

Input fields

slugString
labelString
labelI18nJSON
descriptionString

UpdateLabelInput

Input fields

nameString
descriptionString
colorString
activeBoolean

UpdateMemberRoleInput

Input fields

memberIdString!Required
roleRole!Required

UpdateMessageInput

Input fields

messageIdString
updatedAtDateTime
textString
captionString
Caption for media messages
reactionMessageReactionInput
resolvedBoolean
mentions[ID!]

UpdateNewsCategoryInput

Input fields

slugString
labelString
labelI18nJSON
descriptionString

UpdateNewsPostInput

Input fields

integrationIds[ID!]
titleString
slugString
excerptString
contentMarkdownString
bodyFormatString
localeString
coverImageUrlID
audienceModeNewsAudienceMode
authorIds[ID!]
categoryIds[ID!]
tagIds[ID!]
knowledgeAudienceKnowledgeAudienceInput
Who the AI may answer from this item for (EVERYONE clears it)

UpdateNewsTagInput

Input fields

slugString
labelString
labelI18nJSON
descriptionString

UpdateWebIntegrationInput

Input fields

nameString
allowedOrigins[String!]
defaultLocaleString
supportedLocales[String!]
contentLocaleFallbackBoolean
localeStrategyWebLocaleStrategy
securityWebSecurityInput
greetingI18nJSON
messengerI18nJSON
prechatFormI18nJSON
homeLayoutI18nJSON
aiAutoReplyModeAiAutoReplyMode
aiAutoReplyAssistantIdID
aiAutoReplyRules[AiAutoReplyRuleInput!]
themeWebThemeInput
defaultTabWebDefaultTab
homeLayoutJSON
featuresWebFeaturesInput
trackingWebTrackingInput
prechatFormWebPrechatFormInput
disabledBoolean
logoWebLogoInput
operatorAvatars[WebOperatorAvatarInput!]
greetingWebGreetingInput
soundsWebSoundsInput
brandingWebBrandingInput
botProtectionWebBotProtectionInput
messengerWebMessengerConfigInput

UpdateWhatsAppCarouselCardInput

Input fields

cardIndexInt!Required
Card index to update (0-based)
bodyVariableMappings[WhatsAppVariableMappingInput!]
Updated variable mappings for card body text.
defaultMediaIdString
Updated default media ID for card header.
defaultProductRetailerIdString
Updated default product retailer ID for PRODUCT header cards.

UpdateWhatsAppTemplateButtonDefaultsInput

Input fields

buttonIndexInt!Required
Button index (0-based) within the BUTTONS component
defaultProductRetailerIdString
Updated default product retailer ID (for CATALOG thumbnail)
defaultMpmConfigWhatsAppMPMDefaultConfigInput
Updated default MPM configuration

UpdateWhatsAppTemplateComponentInput

Input fields

typeWhatsAppTemplateComponentType!Required
Component type to update (HEADER, BODY, etc.)
variableMappings[WhatsAppVariableMappingInput!]
Updated variable mappings for this component. Maps WhatsApp positional variables to Wexio variables.
defaultMediaIdString
Updated default media ID for HEADER components with IMAGE, VIDEO, DOCUMENT format.
cards[UpdateWhatsAppCarouselCardInput!]
For CAROUSEL: updated card variable mappings and default media.
defaultProductRetailerIdString
Updated default product retailer ID for PRODUCT header (SPM templates).
expirationTimeMsFloat
Updated default expiration timestamp (Unix ms) for LIMITED_TIME_OFFER components.
buttonDefaults[UpdateWhatsAppTemplateButtonDefaultsInput!]
Updated button defaults (product config for MPM/CATALOG buttons).

UpdateWhatsAppTemplateInput

Input fields

templateIdString!Required
Template ID to update
components[UpdateWhatsAppTemplateComponentInput!]
Component updates (only variableMappings and defaultMediaId can be updated)

UpdateWhatsAppTemplateResult

Fields

successBoolean!Required
errorString
templateWhatsAppTemplate

User

Fields

_idString!Required
createdAtDateTime!Required
updatedAtDateTime!Required
nameString
emailString!Required
photoMedia
partnerOfString
authProviderAuthProvider
authProviderIdString
providerString
providerIdString
ssoOrganisationIdString
twoFactorEnabledBoolean!Required
localeLocale!Required
Preferred UI locale
statusUserStatus!Required
organisations[Organisation!]!Required
presencePresenceStatus!Required
lastSeenAtDateTime
statusMessageStatusMessage
voiceProfileMedia
Operator's voice sample media for personalised TTS (cross-org)

UserStatus

Value
PENDING
ACTIVE

WebAppConfig

Fields

urlString!Required
HTTPS URL of the Web App

WebBotProtectionInput

Input fields

turnstileEnabledBoolean
turnstileSiteKeyString
turnstileSecretString

WebBrandingInput

Input fields

hiddenBoolean

WebDefaultTab

Value
HOME
MESSENGER
HELP
NEWS
PROFILE

WebFeaturesInput

Input fields

homeBoolean
messengerBoolean
helpBoolean
newsBoolean
profileBoolean

WebGreetingInput

Input fields

headlineString
subheadlineString

WebIntegration

Fields

_idID!Required
nameString!Required
defaultLocaleString!Required
supportedLocales[String!]!Required
contentLocaleFallbackBoolean!Required
localeStrategyWebLocaleStrategy!Required
securityWebIntegrationSecurity!Required
greetingI18nJSON
messengerI18nJSON
prechatFormI18nJSON
homeLayoutI18nJSON
publicKeyString!Required
allowedOrigins[String!]!Required
aiAutoReplyWebIntegrationAiAutoReply!Required
themeWebIntegrationTheme
logoWebIntegrationLogo
showLogoInLauncherBoolean
operatorAvatars[WebIntegrationOperatorAvatar!]!Required
greetingWebIntegrationGreeting
soundsWebIntegrationSounds!Required
brandingWebIntegrationBranding!Required
botProtectionWebIntegrationBotProtection!Required
featuresWebIntegrationFeatures!Required
trackingWebIntegrationTracking!Required
defaultTabWebDefaultTab!Required
messengerWebIntegrationMessengerConfig!Required
homeLayoutJSON
prechatFormWebIntegrationPrechatForm!Required
disabledBoolean!Required
createdAtDateTime!Required
updatedAtDateTime!Required

WebIntegrationAiAutoReply

Fields

modeAiAutoReplyMode!Required
assistantIdID
rules[AiAutoReplyRule!]

WebIntegrationBotProtection

Fields

turnstileEnabledBoolean!Required
turnstileSiteKeyString

WebIntegrationBranding

Fields

hiddenBoolean!Required

WebIntegrationFeatures

Fields

homeBoolean!Required
messengerBoolean!Required
helpBoolean!Required
newsBoolean!Required
profileBoolean!Required

WebIntegrationGreeting

Fields

headlineString
subheadlineString

Fields

lightMedia
darkMedia

WebIntegrationMessengerConfig

Fields

titleString
descriptionString
aiAssistantAvatarMedia
aiAssistantNameString
commands[String!]
messages[WebIntegrationMessengerMessage!]
showRelatedNewsBoolean!Required
showRelatedHelpArticlesBoolean!Required
showReactionCountsBoolean!Required
profileWebIntegrationMessengerProfileConfig!Required

WebIntegrationMessengerMessage

Fields

idString
kindWebMessengerMessageKind!Required
textString!Required

WebIntegrationMessengerProfileConfig

Fields

fields[String!]!Required

WebIntegrationOperatorAvatar

Fields

mediaMedia!Required
altString!Required

WebIntegrationPrechatForm

Fields

enabledBoolean!Required
fields[PrechatFormField!]!Required

WebIntegrationSecurity

Fields

requireAuthBoolean!Required
googleWebIntegrationSecurityGoogle!Required
passkeyWebIntegrationSecurityPasskey!Required

WebIntegrationSecurityGoogle

Fields

enabledBoolean!Required
clientIdString

WebIntegrationSecurityPasskey

Fields

enabledBoolean!Required

WebIntegrationSoundChoice

Fields

presetIdString
mediaMedia

WebIntegrationSounds

Fields

enabledBoolean!Required
inboundWebIntegrationSoundChoice
outboundWebIntegrationSoundChoice
volumeFloat!Required

WebIntegrationTheme

Fields

lightWebIntegrationThemePalette
darkWebIntegrationThemePalette
radiiWebIntegrationThemeRadii
themeModeWebThemeMode
fontFamilyString
launcherPositionLauncherPosition

WebIntegrationThemePalette

Fields

backgroundString
surfaceString
surfaceElevatedString
textString
textMutedString
textSubtleString
borderString
borderStrongString
primaryString
primaryHoverString
primaryForegroundString
launcherBackgroundString
launcherForegroundString
successString
dangerString

WebIntegrationThemeRadii

Fields

smFloat
mdFloat
lgFloat
xlFloat

WebIntegrationTracking

Fields

trackWidgetLinksBoolean!Required
trackWebsitePagesBoolean!Required

WebIntegrationWithSecret

Fields

integrationWebIntegration!Required
sharedSecretString!Required

WebLocaleStrategy

Value
AUTO
WEBSITE
DEFAULT

WebLogoInput

Input fields

lightID
darkID
showLogoInLauncherBoolean

WebMessengerConfigInput

Input fields

titleString
descriptionString
aiAssistantAvatarID
aiAssistantNameString
commands[String!]
messages[WebMessengerMessageInput!]
showRelatedNewsBoolean
showRelatedHelpArticlesBoolean
showReactionCountsBoolean
profileWebMessengerProfileInput

WebMessengerMessageInput

Input fields

idString
kindWebMessengerMessageKind!Required
textString!Required

WebMessengerMessageKind

Value
HINT
SYSTEM
MESSAGE

WebMessengerProfileInput

Input fields

fields[String!]!Required

WebOperatorAvatarInput

Input fields

mediaID!Required
altString!Required

WebPrechatFieldInput

Input fields

kindPrechatFieldKind!Required
keyString!Required
labelString!Required
requiredBoolean!Required

WebPrechatFormInput

Input fields

enabledBoolean!Required
fields[WebPrechatFieldInput!]!Required

WebSecurityGoogleInput

Input fields

enabledBoolean
clientIdString

WebSecurityInput

Input fields

requireAuthBoolean
googleWebSecurityGoogleInput
passkeyWebSecurityPasskeyInput

WebSecurityPasskeyInput

Input fields

enabledBoolean

WebSoundChoiceInput

Input fields

presetIdString
mediaID

WebSoundsInput

Input fields

enabledBoolean
inboundWebSoundChoiceInput
outboundWebSoundChoiceInput
volumeFloat

WebThemeInput

Input fields

lightWebThemePaletteInput
darkWebThemePaletteInput
radiiWebThemeRadiiInput
themeModeWebThemeMode
fontFamilyString
launcherPositionLauncherPosition

WebThemeMode

Value
AUTO
LIGHT
DARK

WebThemePaletteInput

Input fields

backgroundString
surfaceString
surfaceElevatedString
textString
textMutedString
textSubtleString
borderString
borderStrongString
primaryString
primaryHoverString
primaryForegroundString
launcherBackgroundString
launcherForegroundString
successString
dangerString

WebThemeRadiiInput

Input fields

smInt
mdInt
lgInt
xlInt

WebTrackingInput

Input fields

trackWidgetLinksBoolean
trackWebsitePagesBoolean

WebhookDeliveryLog

Fields

_idString!Required
connectionIdString!Required
organisationIdString!Required
sourceOrganisationIdString
eventIdString!Required
eventNameString!Required
statusWebhookDeliveryStatus!Required
attemptInt!Required
destinationUrlString
responseStatusInt
errorMessageString
durationMsInt
payloadJSON
createdAtDateTime!Required
updatedAtDateTime!Required
sourceOrganisationNameString
sourceExternalIdString

WebhookDeliveryStatus

Value
PENDING
SUCCESS
RETRYING
FAILED
DEAD_LETTER

WebhookOutboundHistoryPage

Fields

items[WebhookDeliveryLog!]!Required
totalInt!Required
nextCursorDateTime
hasMoreBoolean!Required

WhatsAppCarouselCard

Fields

cardIndexInt
Card index (0-based, max 9 cards)
headerFormatWhatsAppHeaderFormat
Header format for this card (IMAGE or VIDEO only)
bodyTextString
Body text for this card (supports {{1}}, {{2}}, etc.)
bodyExample[String!]
Example values for body variables
bodyVariableMappings[WhatsAppVariableMapping!]
Variable mappings for body text
buttons[WhatsAppTemplateButton!]
Buttons for this card (max 2)
defaultMediaMedia
Default media for card header
defaultProductRetailerIdString
Default product retailer ID for PRODUCT header cards. Used as fallback at send time.

WhatsAppCarouselCardInput

Input fields

cardIndexInt!Required
Card index (0-based, 0-9). Must be sequential starting from 0.
headerFormatWhatsAppHeaderFormat
Header format for this card. IMAGE, VIDEO for Media Cards; PRODUCT for Product Cards.
bodyTextString
Body text for this card. Max 160 characters. Supports {{1}}, {{2}}, etc.
bodyExample[String!]
Example values for body variables.
bodyVariableMappings[WhatsAppVariableMappingInput!]
Variable mappings for body text.
buttons[WhatsAppTemplateButtonInput!]
Buttons for this card. Max 2 buttons. Only QUICK_REPLY and URL allowed.
defaultMediaIdString
Default media ID for card header.
defaultProductRetailerIdString
Default product retailer ID for PRODUCT header cards. Used as fallback at send time.

WhatsAppHeaderFormat

Value
TEXT
IMAGE
VIDEO
DOCUMENT
LOCATION
PRODUCT

WhatsAppMPMDefaultConfig

Fields

thumbnailProductRetailerIdString!Required
Product retailer ID for the thumbnail image
sections[WhatsAppMPMDefaultSection!]!Required
Product sections (max 10 sections, 30 products total)

WhatsAppMPMDefaultConfigInput

Input fields

thumbnailProductRetailerIdString!Required
Product retailer ID for the thumbnail image
sections[WhatsAppMPMDefaultSectionInput!]!Required
Product sections (max 10 sections, 30 products total)

WhatsAppMPMDefaultSection

Fields

titleString!Required
Section title (max 24 characters)
productRetailerIds[String!]!Required
Product retailer IDs (SKUs) in this section

WhatsAppMPMDefaultSectionInput

Input fields

titleString!Required
Section title (max 24 characters)
productRetailerIds[String!]!Required
Product retailer IDs (SKUs) in this section

WhatsAppTemplate

Fields

_idString!Required
organisationString!Required
integrationString!Required
nameString!Required
displayNameString
languageString!Required
categoryWhatsAppTemplateCategory!Required
statusWhatsAppTemplateStatus!Required
components[WhatsAppTemplateComponent!]!Required
externalTemplateIdString
rejectionReasonString
qualityScoreString
variableCountFloat
lastSyncedAtDateTime
createdAtDateTime
updatedAtDateTime

WhatsAppTemplateButton

Fields

typeWhatsAppTemplateButtonType!Required
Button type (QUICK_REPLY, URL, PHONE_NUMBER, COPY_CODE, MPM, SPM)
textString!Required
Button label text (max 25 characters)
urlString
URL for URL buttons (can contain {{1}} for dynamic part)
phoneNumberString
Phone number for PHONE_NUMBER buttons
exampleString
Example value for COPY_CODE buttons or URL variable
variableMappingWhatsAppVariableMapping
Variable mapping for dynamic URL/COPY_CODE parameters (when URL contains {{1}} or for coupon codes)
defaultProductRetailerIdString
Default product retailer ID. For CATALOG: thumbnail product. Stored on template, used as fallback at send time.
defaultMpmConfigWhatsAppMPMDefaultConfig
Default MPM configuration with sections and products. Stored on template, used as fallback when no productOverrides.mpmAction provided at send time.

WhatsAppTemplateButtonInput

Input fields

typeWhatsAppTemplateButtonType!Required
Button type: QUICK_REPLY, URL, PHONE_NUMBER, COPY_CODE, OTP, FLOW, CATALOG, MPM, SPM, VOICE_CALL
textString!Required
Button label text (max 25 characters)
urlString
URL for URL buttons. Can include one variable appended to the end (e.g., https://example.com/order?id=\{\{1\}\})
phoneNumberString
Phone number for PHONE_NUMBER buttons. Must be in international format.
exampleString
Example value for COPY_CODE buttons (max 15 characters) or URL variable
flowIdString
Flow ID for FLOW buttons
flowActionString
Flow action for FLOW buttons (navigate or data_exchange)
defaultProductRetailerIdString
Default product retailer ID. For CATALOG: default thumbnail product. Stored on template, used as fallback at send time.
defaultMpmConfigWhatsAppMPMDefaultConfigInput
Default MPM configuration. Stored on template, used as fallback when no mpmAction provided at send time.

WhatsAppTemplateButtonType

Value
QUICK_REPLY
URL
PHONE_NUMBER
COPY_CODE
CATALOG
MPM
SPM

WhatsAppTemplateCategory

Value
MARKETING
UTILITY
AUTHENTICATION

WhatsAppTemplateComponent

Fields

typeWhatsAppTemplateComponentType!Required
textString
formatWhatsAppHeaderFormat
buttons[WhatsAppTemplateButton!]
example[String!]
variableMappings[WhatsAppVariableMapping!]
Mapping of WhatsApp positions to Wexio variables
defaultMediaMedia
Default media for IMAGE, VIDEO, DOCUMENT headers. Used as fallback when user does not provide media.
defaultProductRetailerIdString
Default product retailer ID for PRODUCT header format (SPM templates). Used as fallback at send time.
hasExpirationBoolean
For LIMITED_TIME_OFFER: enables countdown timer display. When true, expiration_time_ms must be provided at send time.
expirationTimeMsFloat
Default expiration timestamp (Unix ms) for LIMITED_TIME_OFFER templates. Used as fallback when not provided at send time.
cards[WhatsAppCarouselCard!]
For CAROUSEL: array of 2-10 cards, each with header, body, and buttons

WhatsAppTemplateComponentInput

Input fields

typeWhatsAppTemplateComponentType!Required
Component type: HEADER, BODY, FOOTER, BUTTONS, LIMITED_TIME_OFFER, CAROUSEL
textString
Text content. BODY: max 1024 chars, HEADER/FOOTER: max 60 chars, LIMITED_TIME_OFFER: max 16 chars
formatWhatsAppHeaderFormat
Format for HEADER component: TEXT, IMAGE, VIDEO, DOCUMENT, LOCATION
buttons[WhatsAppTemplateButtonInput!]
Buttons for BUTTONS component. Max 10 total (2 URL, 1 PHONE_NUMBER, 1 COPY_CODE, 10 QUICK_REPLY)
example[String!]
Example values for variables. Required for template approval.
variableMappings[WhatsAppVariableMappingInput!]
Mapping of WhatsApp variable positions ({{1}}, {{2}}) to Wexio variables for auto-resolution at send time
defaultMediaIdString
Media ID for IMAGE, VIDEO, DOCUMENT headers. Used as fallback when user does not provide media at send time.
defaultProductRetailerIdString
Default product retailer ID for PRODUCT header (SPM templates). Used as fallback at send time.
hasExpirationBoolean
For LIMITED_TIME_OFFER: enables countdown timer display. When true, expiration_time_ms must be provided at send time.
expirationTimeMsFloat
Default expiration timestamp (Unix ms) for LIMITED_TIME_OFFER templates. Used as fallback when not provided at send time via variableOverrides.
cards[WhatsAppCarouselCardInput!]
For CAROUSEL: array of 2-10 cards. Each card has header (IMAGE/VIDEO only), body, and buttons (max 2).

WhatsAppTemplateComponentType

Value
HEADER
BODY
FOOTER
BUTTONS
LIMITED_TIME_OFFER
CAROUSEL
CALL_PERMISSION_REQUEST

WhatsAppTemplateConnection

Fields

items[WhatsAppTemplate!]!Required
totalCountInt!Required
hasNextPageBoolean!Required
hasPreviousPageBoolean!Required

WhatsAppTemplateFilterInput

Input fields

integrationIds[String!]
Filter by integration IDs
categories[WhatsAppTemplateCategory!]
Filter by categories
statuses[WhatsAppTemplateStatus!]
Filter by statuses
languages[String!]
Filter by languages
searchString
Search by name or content
skipInt
Skip (offset) for pagination
limitInt
Limit (page size) for pagination
sortByWhatsAppTemplateSortField
sortOrderSortOrder

WhatsAppTemplateSortField

Value
NAME
CREATED_AT
UPDATED_AT
STATUS
CATEGORY

WhatsAppTemplateStatus

Value
PENDING
APPROVED
REJECTED
PAUSED
DISABLED
IN_APPEAL
DELETED

WhatsAppTemplateSyncResult

Fields

syncedInt!Required
createdInt!Required
updatedInt!Required
deletedInt!Required
errors[String!]!Required

WhatsAppVariableMapping

Fields

positionInt!Required
WhatsApp variable position (1, 2, 3, etc.)
valueString!Required
Template value: plain text, variable ({{contact.first_name}}), or mixed (Hello {{contact.first_name}}!)

WhatsAppVariableMappingInput

Input fields

positionInt!Required
WhatsApp variable position (1, 2, 3, etc.)
valueString!Required
Template value: plain text, variable ({{contact.first_name}}), or mixed (Hello {{contact.first_name}}!)

Tech Providers

Provision client orgs, the fan-out webhook and the usage rollup

Webhooks

One signed endpoint that receives events for every client org you manage

On this page

AIAssistantAIAssistantContextAIAssistantMediaSettingsAIAssistantSettingsActionButtonActionContextActiveFlowExecutionAddOrgMemberDirectInputAiAutoReplyModeAiAutoReplyRuleAiAutoReplyRuleInputAssignmentInitiatorAssistantPinSourceAuthMethodAuthProviderBlockScopeBotCarouselCardOverrideCatalogActionInputChannelIdentityChatChatAssignmentStatusChatCategoryChatCollectionChatFieldKeyChatMemberChatMemberPageChatStatusChatTypeCleanupDeletedCountsClientOrgsFilterInputClientOrgsPageCollectionChatCountCollectionConversationCountCollectionFilterFieldCollectionRuleCollectionRuleInputCommentWebhookStatusConnectWhatsAppChannelInputContactContactAddressContactApiContactApiChannelInputContactApiFieldFilterInputContactApiFieldInputContactApiFilterInputContactApiPageContactApiPaginationInputContactApiWriteInputContactChannelContactChannelKindContactEmailContactOrgContactPhoneContactUrlConversationConversationChannelConversationChannelGroupConversationStatusCreateChatCollectionInputCreateClientOrgInputCreateCombinedMessageInputCreateFieldDefinitionDtoCreateHelpArticleInputCreateHelpFolderInputCreateHelpTagInputCreateLabelInputCreateMediaInputCreateNewsCategoryInputCreateNewsPostInputCreateNewsTagInputCreateWebIntegrationInputCreateWhatsAppTemplateInputCreateWhatsAppTemplateResultCursorPaginatedChatCursorPaginatedConversationDeleteChatResultDeleteWhatsAppTemplateResultEraseCountEraseInputErasePreviewTypeEraseResultTypeFieldGroupFieldTypeFieldVisibilityFilterOperatorFlowInitiatorGameAnimationGamePhotoGetCursorPaginatedInputGetSortedInputHelpArticleHelpArticleContentFormatHelpArticleSortHelpArticleStatusHelpFolderHelpFolderCountsHelpFolderCountsEntryHelpRssSourceConfigHelpSourceHelpSourceFieldMapHelpSourceModeHelpTagHostedConnectChannelInboxCountsIntegrationIntegrationAiAutoReplyIntegrationAiAutoReplyInputIntegrationCategoryIntegrationCleanupResultIntegrationErrorIntegrationProviderIntegrationStatusKnowledgeAudienceKnowledgeAudienceInputKnowledgeAudienceKindLabelLauncherPositionLocaleLoginUrlConfigMPMActionInputMPMProductItemInputMPMSectionInputMediaMediaGroupMessageMediaTranscriptionMediaTypeMediaTypeCountMentionReadStatusMentionRecipientStatusMergedInfoMessageMessageActionsMessageAuthorMessageButtonMessageButtonInputMessageDeliveryStatusMessageDiceMessageDirectionMessageGameMessageLocationMessageOrgSenderMessagePollMessageProductMessageReactionMessageReactionInputMessageRepliedToCommentMessageSourceMessageTypeMessageUnsupportedModelCapabilityModelInfoModelSlotsMoveCollectionInputNewsAudienceModeNewsCategoryNewsPostNewsPostSortNewsPostStatusNewsSourceNewsSourceFieldMapNewsSourceModeNewsTagOrgTeamMemberOrganisationOrganisationCleanupResultOrganisationKindOrganisationMemberStatusOutboundWebhookEventNamePaginateMessagesInputPaginatedHelpArticlesPaginatedMessagesPaginatedNewsPostsPaginationMetaPartnerDeleteConversationResultPartnerRelationPartnerUsageSummaryPartnerWebhookOutputPartnerWebhookStatusPeoplePeopleFieldDefinitionPeopleFieldValuePeopleFieldsFilterDtoPollOptionPrechatFieldKindPrechatFormFieldPresenceStatusPresetStatusTypePriorityProductCarouselCardOverrideProductTemplateOverridesReactionTypeReactionUserRegisteredPartnerWebhookRequestChatConfigRequestPollConfigRequestUsersConfigRoleRotatedPartnerWebhookSecretRssSourceConfigSPMHeaderInputScanStatusSearchChatsInputSearchChatsResultSearchConversationsResultSearchMessagesInputSendWhatsAppTemplateInputSendWhatsAppTemplateResultSetFieldValueDtoSetMessageLabelsInputSetTelegramBotCommandsInputSetTelegramBotDescriptionInputSetTelegramBotNameInputSetTelegramBotShortDescriptionInputSetTelegramMenuButtonInputSocialPaginationInputSortDirectionSortOrderSpamBlockInitiatorSpamBlockModeStatusMessageSwitchInlineQueryChosenChatConfigSystemAssignInfoSystemFlowInfoSystemLoginInfoSystemMessageInfoSystemMessageTypeSystemSpamInfoSystemStatusChangeInfoTechProviderAllTimeTechProviderChildUsagePageTechProviderChildUsageRowTechProviderMonthlyUsageTechProviderUsageFilterInputTelegramBotCommandTelegramBotCommandInputTelegramBotSettingsTelegramMenuButtonTelegramMenuButtonInputTelegramMenuButtonTypeTemplateCardButtonTemplateCardPreviewTemplateInfoTemplateLocationInfoTemplateLtoInfoTemplateVariableOverridesTenantConnectionStatusTenantDatabaseStatusTenantRedisStatusThreadFilterThreadsPageThumbnailThumbnailInputTranscriptionSegmentTranscriptionWordTranslatedTranscriptionUnsupportedReasonUpdateChannelInputUpdateChatCollectionInputUpdateChatFieldInputUpdateFieldDefinitionDtoUpdateHelpArticleInputUpdateHelpFolderInputUpdateHelpTagInputUpdateLabelInputUpdateMemberRoleInputUpdateMessageInputUpdateNewsCategoryInputUpdateNewsPostInputUpdateNewsTagInputUpdateWebIntegrationInputUpdateWhatsAppCarouselCardInputUpdateWhatsAppTemplateButtonDefaultsInputUpdateWhatsAppTemplateComponentInputUpdateWhatsAppTemplateInputUpdateWhatsAppTemplateResultUserUserStatusWebAppConfigWebBotProtectionInputWebBrandingInputWebDefaultTabWebFeaturesInputWebGreetingInputWebIntegrationWebIntegrationAiAutoReplyWebIntegrationBotProtectionWebIntegrationBrandingWebIntegrationFeaturesWebIntegrationGreetingWebIntegrationLogoWebIntegrationMessengerConfigWebIntegrationMessengerMessageWebIntegrationMessengerProfileConfigWebIntegrationOperatorAvatarWebIntegrationPrechatFormWebIntegrationSecurityWebIntegrationSecurityGoogleWebIntegrationSecurityPasskeyWebIntegrationSoundChoiceWebIntegrationSoundsWebIntegrationThemeWebIntegrationThemePaletteWebIntegrationThemeRadiiWebIntegrationTrackingWebIntegrationWithSecretWebLocaleStrategyWebLogoInputWebMessengerConfigInputWebMessengerMessageInputWebMessengerMessageKindWebMessengerProfileInputWebOperatorAvatarInputWebPrechatFieldInputWebPrechatFormInputWebSecurityGoogleInputWebSecurityInputWebSecurityPasskeyInputWebSoundChoiceInputWebSoundsInputWebThemeInputWebThemeModeWebThemePaletteInputWebThemeRadiiInputWebTrackingInputWebhookDeliveryLogWebhookDeliveryStatusWebhookOutboundHistoryPageWhatsAppCarouselCardWhatsAppCarouselCardInputWhatsAppHeaderFormatWhatsAppMPMDefaultConfigWhatsAppMPMDefaultConfigInputWhatsAppMPMDefaultSectionWhatsAppMPMDefaultSectionInputWhatsAppTemplateWhatsAppTemplateButtonWhatsAppTemplateButtonInputWhatsAppTemplateButtonTypeWhatsAppTemplateCategoryWhatsAppTemplateComponentWhatsAppTemplateComponentInputWhatsAppTemplateComponentTypeWhatsAppTemplateConnectionWhatsAppTemplateFilterInputWhatsAppTemplateSortFieldWhatsAppTemplateStatusWhatsAppTemplateSyncResultWhatsAppVariableMappingWhatsAppVariableMappingInput