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

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" }

objectListConfigInput

key
String
label
String
type
String
Sample
{ "key": "Example String", "label": "Example String", "type": "Example String" }

PdfAttachmentInput

Input for uploading a PDF attachment with page images.

The full PDF file.

Individual page images for the PDF.

Sample
{ "pdf": { "__typename": "AttachmentInput" }, "pages": [ { "__typename": "AttachmentInput" } ] }

SubmissionFilter

operator
String
value
formFieldId
String
Sample
{ "operator": "Example String", "value": "Example Custom Scalar", "formFieldId": "Example String" }

Scalars

Overview