Skip to content

GraphQL Overview

Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.

Conversations & messaging

Queries

Overview

Mutations

Overview

Objects

Overview

Enums

Overview
Contacts & CRM

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview
Products & commerce

Queries

Overview

Mutations

Overview

Objects

Overview
Apps & credentials

Queries

Overview

Mutations

Overview

Objects

Overview
Organization

Queries

Overview

Objects

Overview

Enums

Overview
Other

Queries

Overview

Mutations

Overview

Objects

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

AttachmentInput

url
String!,non-null
name
String!,non-null
type
String
size
Float
duration
Float
locationData
Sample
{ "url": "Example String", "name": "Example String", "type": "Example String", "size": 40, "duration": 40, "locationData": { "__typename": "LocationDataInput" } }

KnowledgeBaseArticleDoc

Input for creating or editing a knowledge base article.

code
String

Unique code identifier.

title
String!,non-null

The article title (required).

summary
String

Brief summary or excerpt.

content
String!,non-null

Full article content in HTML (required).

status
String!,non-null

Publication status: 'draft', 'publish', or 'scheduled' (required).

isPrivate
Boolean

Whether this article is only visible to team members.

reactionChoices
[String]

Available emoji reaction types.

categoryIds
[String]

Category IDs to assign this article to.

topicId
String

The topic this article belongs to.

categoryId
String

The primary category this article belongs to.

Featured image for the article.

File attachments.

pdfAttachment

PDF attachment with page images.

scheduledDate

Scheduled publication date.

Forms to embed in this article.

Sample
{ "code": "Example String", "title": "Example String", "summary": "Example String", "content": "Example String", "status": "Example String", "isPrivate": true, "reactionChoices": [ "Example String" ], "categoryIds": [ "Example String" ], "topicId": "Example String", "categoryId": "Example String", "image": { "__typename": "AttachmentInput" }, "attachments": [ { "__typename": "AttachmentInput" } ], "pdfAttachment": { "__typename": "PdfAttachmentInput" }, "scheduledDate": "Example Custom Scalar", "forms": [ { "__typename": "FormCodeInput" } ] }

KnowledgeBaseCategoryDoc

Input for creating or editing a knowledge base category.

code
String

Unique code identifier.

title
String!,non-null

The category title (required).

description
String

Description of what this category covers.

articleIds
[String]

Article IDs to include in this category.

icon
String!,non-null

Icon identifier (required).

topicIds
[String]

Topic IDs this category belongs to.

topicId
String

Primary topic ID.

parentCategoryId
String

Parent category ID for nesting.

Sample
{ "code": "Example String", "title": "Example String", "description": "Example String", "articleIds": [ "Example String" ], "icon": "Example String", "topicIds": [ "Example String" ], "topicId": "Example String", "parentCategoryId": "Example String" }

KnowledgeBaseTopicDoc

Input for creating or editing a knowledge base topic.

code
String

Unique code identifier.

title
String!,non-null

The topic title (required).

description
String

Description of the topic.

categoryIds
[String]

Category IDs to include in this topic.

color
String
backgroundImage
String

Background image URL.

languageCode
String

ISO language code.

Sample
{ "code": "Example String", "title": "Example String", "description": "Example String", "categoryIds": [ "Example String" ], "color": "Example String", "backgroundImage": "Example String", "languageCode": "Example String" }

LocationDataInput

latitude
Float!,non-null
longitude
Float!,non-null
name
String
address
String
Sample
{ "latitude": 40, "longitude": 40, "name": "Example String", "address": "Example String" }

LocationOptionInput

lat
Float
lng
Float
description
String
Sample
{ "lat": 40, "lng": 40, "description": "Example String" }

LogicInput

fieldId
String
tempFieldId
String
logicOperator
String
logicValue
Sample
{ "fieldId": "Example String", "tempFieldId": "Example String", "logicOperator": "Example String", "logicValue": "Example Custom Scalar" }

MessageContextInput

Input for threading and mention context.

replyTo
String

The message ID this is replying to.

isForwarded
Boolean

Whether this message was forwarded.

mentions
[String]

User IDs mentioned in this message.

Sample
{ "replyTo": "Example String", "isForwarded": true, "mentions": [ "Example String" ] }

MessageMediaInput

Input for media message content.

File attachments.

caption
String

Optional caption.

Sample
{ "attachments": [ { "__typename": "AttachmentInput" } ], "caption": "Example String" }

MessageSenderInput

Input for identifying the message sender.

kind
String!,non-null

Sender kind: 'user', 'customer', 'bot', 'ai_assistant', 'system', 'visitor'.

id
String

The sender's platform ID.

Sample
{ "kind": "Example String", "id": "Example String" }

MessageTextInput

Input for text message content.

body
String!,non-null

The message body.

preview
String

Optional short preview.

Sample
{ "body": "Example String", "preview": "Example String" }

Scalars

Overview