Skip to content
Developers/
Other
/
/
ColumnConfigItem

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

AssignedPayload

Payload for assigned action.

assignedTo
String
assignedUserId
String
assignedDepartmentId
String
assignedBy
String
performedBy
String
assignedToUser
User

Resolved user who was assigned to.

assignedUser
User

Resolved user who was assigned (by assignedUserId).

assignedByUser
User

Resolved user who performed the assignment.

performedByUser
User

Resolved user who performed the action.

assignedDepartment
Department

Resolved department the conversation was assigned to.

Sample
{
  "assignedTo": "Example String",
  "assignedUserId": "Example String",
  "assignedDepartmentId": "Example String",
  "assignedBy": "Example String",
  "performedBy": "Example String",
  "assignedToUser": {
    "__typename": "User"
  },
  "assignedUser": {
    "__typename": "User"
  },
  "assignedByUser": {
    "__typename": "User"
  },
  "performedByUser": {
    "__typename": "User"
  },
  "assignedDepartment": {
    "__typename": "Department"
  }
}
Referenced in
ActionsPayload

Attachment

url
String!,non-null
name
String
type
String
size
Float
duration
Float
locationData
LocationData
Sample
{
  "url": "Example String",
  "name": "Example String",
  "type": "Example String",
  "size": 40,
  "duration": 40,
  "locationData": {
    "__typename": "LocationData"
  }
}
Referenced in
KnowledgeBaseArticle.attachments
KnowledgeBaseArticle.image
MessageMedia.attachments
MessageOrderProductItem.attachment
PdfAttachment.pdf
PdfAttachment.pages
Product.attachment
Product.attachmentMore
Product.media
ProductCategory.attachment
ProductOptionValue.image
ProductVariant.image

ColumnConfigItem

name
String
label
String
order
Int
Sample
{
  "name": "Example String",
  "label": "Example String",
  "order": 40
}

ConvertedToCardPayload

Payload for converted_to_card action.

cardType
String
performedBy
String
performedByUser
User

Resolved user who performed the conversion.

Sample
{
  "cardType": "Example String",
  "performedBy": "Example String",
  "performedByUser": {
    "__typename": "User"
  }
}
Referenced in
ActionsPayload

EmailAddress

An email address with optional display name.

name
String

Display name (e.g. 'John Doe').

address
String!,non-null

Email address (e.g. 'john@example.com').

Sample
{
  "name": "Example String",
  "address": "Example String"
}
Referenced in
MessageEmail.from
MessageEmail.to
MessageEmail.cc
MessageEmail.bcc

EmailAttachment

Email-specific attachment metadata.

filename
String

Original filename.

mimeType
String

MIME type.

size
Int

File size in bytes.

contentId
String

Content-ID for inline/embedded images.

attachmentId
String

Server-side storage ID for download.

Sample
{
  "filename": "Example String",
  "mimeType": "Example String",
  "size": 40,
  "contentId": "Example String",
  "attachmentId": "Example String"
}
Referenced in
MessageEmail.attachments

HealthEntity

entity_type
String
id
String
can_send_message
String
additional_info
[String]
Sample
{
  "entity_type": "Example String",
  "id": "Example String",
  "can_send_message": "Example String",
  "additional_info": [
    "Example String"
  ]
}
Referenced in
WhatsappHealthStatus.entities

InboxField

Available custom field definitions for inbox entities.

customer
[Field]

Custom fields available on customer records.

conversation
[Field]

Custom fields available on conversations.

device
[Field]

Custom fields available on device/browser data.

Sample
{
  "customer": [
    {
      "__typename": "Field"
    }
  ],
  "conversation": [
    {
      "__typename": "Field"
    }
  ],
  "device": [
    {
      "__typename": "Field"
    }
  ]
}

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview