Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ThreadMessageAttachment

Represents an attachment in a message.

id
ID!,non-null

Attachment id

name
String!,non-null

Attachment file name

size
Long!,non-null

Attachment size

downloadUrl
Url!,non-null

Attachment download url to retrieve the file

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "size": "Example Custom Scalar", "downloadUrl": "Example Custom Scalar" }

ThreadMessageSender

Represents the sender of a message.

displayName
String!,non-null

Sender display name

Organization details of the sender

type
String!,non-null

Sender type. Possible values are: CUSTOMER, OPERATOR, SHOP

Sample
{ "displayName": "Example String", "organizationDetails": { "__typename": "ThreadMessageSenderOrganization" }, "type": "Example String" }

ThreadMessageSenderOrganization

Represents the organization details of the sender.

displayName
String!,non-null

Organization display name

Organization id. When type equals OPERATOR, no id will be returned.

type
String!,non-null

Organization type. Possible values are: CUSTOMER, OPERATOR, SHOP.

Sample
{ "displayName": "Example String", "id": "Example String", "type": "Example String" }

ThreadMessageRecipient

Represents a recipient of a message.

displayName
String!,non-null

Recipient display name

Recipient id. When type equals OPERATOR, no id will be returned.

type
String!,non-null

Recipient type. Possible values are: CUSTOMER, OPERATOR, SHOP.

Sample
{ "displayName": "Example String", "id": "Example String", "type": "Example String" }
Referenced in

ThreadMetadata

Represents a thread's metadata.

lastMessageDate
DateTime!,non-null

Date of the last message

lastSender

Last message sender

totalCount
Int!,non-null

Number of messages in the thread

Sample
{ "lastMessageDate": "Example Custom Scalar", "lastSender": { "__typename": "ThreadMessageSender" }, "totalCount": 40 }
Referenced in

ThreadTopic

Represents a thread's topic.

type
String!,non-null

Topic type. Possible values are: FREE_TEXT, REASON_CODE.

value
String!,non-null

Topic value

Sample
{ "type": "Example String", "value": "Example String" }
Referenced in

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview