Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.
Conversations & messaging
Contacts & CRM
Products & commerce
Apps & credentials
Organization
Other
Sample
{ "fieldId": "Example String", "tempFieldId": "Example String", "logicOperator": "Example String", "logicValue": "Example Custom Scalar" }
Input for threading and mention context.
reply
String
The message ID this is replying to.
is
Boolean
Whether this message was forwarded.
mentions
[String]
User IDs mentioned in this message.
Sample
{ "replyTo": "Example String", "isForwarded": true, "mentions": [ "Example String" ] }
Input for media message content.
attachments
File attachments.
caption
String
Optional caption.
Sample
{ "attachments": [ { "__typename": "AttachmentInput" } ], "caption": "Example String" }
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" }
Input for text message content.
body
String!,non-null
The message body.
preview
String
Optional short preview.
Sample
{ "body": "Example String", "preview": "Example String" }
key
String
label
String
type
String
Sample
{ "key": "Example String", "label": "Example String", "type": "Example String" }
Input for uploading a PDF attachment with page images.
The full PDF file.
pages
Individual page images for the PDF.
Sample
{ "pdf": { "__typename": "AttachmentInput" }, "pages": [ { "__typename": "AttachmentInput" } ] }
Referenced in
Sample
{ "operator": "Example String", "value": "Example Custom Scalar", "formFieldId": "Example String" }