Skip to content
Developers/
Other
/
/
Throughput

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

TemplateRendered

Rendered snapshot of a template message.

header
TemplateRenderedHeader
body
String
footer
String
buttons
[TemplateRenderedButton]
carousel
[TemplateRenderedCarouselCard]
lto
TemplateRenderedLTO
Sample
{
  "header": {
    "__typename": "TemplateRenderedHeader"
  },
  "body": "Example String",
  "footer": "Example String",
  "buttons": [
    {
      "__typename": "TemplateRenderedButton"
    }
  ],
  "carousel": [
    {
      "__typename": "TemplateRenderedCarouselCard"
    }
  ],
  "lto": {
    "__typename": "TemplateRenderedLTO"
  }
}
Referenced in
MessageTemplate.rendered

TemplateRenderedButton

type
String
text
String
url
String
phone_number
String
coupon_code
String
Sample
{
  "type": "Example String",
  "text": "Example String",
  "url": "Example String",
  "phone_number": "Example String",
  "coupon_code": "Example String"
}
Referenced in
TemplateRendered.buttons
TemplateRenderedCarouselCard.buttons

TemplateRenderedCarouselCard

header
TemplateRenderedHeader
body
String
buttons
[TemplateRenderedButton]
Sample
{
  "header": {
    "__typename": "TemplateRenderedHeader"
  },
  "body": "Example String",
  "buttons": [
    {
      "__typename": "TemplateRenderedButton"
    }
  ]
}
Referenced in
TemplateRendered.carousel

TemplateRenderedHeader

type
String
text
String
url
String
product_retailer_id
String
catalog_id
String
latitude
Float
longitude
Float
name
String
address
String
Sample
{
  "type": "Example String",
  "text": "Example String",
  "url": "Example String",
  "product_retailer_id": "Example String",
  "catalog_id": "Example String",
  "latitude": 40,
  "longitude": 40,
  "name": "Example String",
  "address": "Example String"
}
Referenced in
TemplateRendered.header
TemplateRenderedCarouselCard.header

TemplateRenderedLTO

expiration_time_ms
Float
Sample
{
  "expiration_time_ms": 40
}
Referenced in
TemplateRendered.lto

Throughput

level
String
Sample
{
  "level": "Example String"
}
Referenced in
WhatsappBusinessPhone.throughput

UnassignedPayload

Payload for unassigned action.

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

Resolved user who was unassigned from.

assignedUser
User

Resolved user who was unassigned (by assignedUserId).

assignedByUser
User

Resolved user who performed the unassignment.

performedByUser
User

Resolved user who performed the action.

assignedDepartment
Department

Resolved department the conversation was unassigned from.

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

UntaggedPayload

Payload for untagged action.

tagName
String
Sample
{
  "tagName": "Example String"
}
Referenced in
ActionsPayload

VariantOptionValue

Option selection on a specific variant.

optionId
String!,non-null
optionName
String!,non-null
valueId
String!,non-null
value
String!,non-null
Sample
{
  "optionId": "Example String",
  "optionName": "Example String",
  "valueId": "Example String",
  "value": "Example String"
}
Referenced in
ProductVariant.optionValues

WAContact

A shared contact from a WhatsApp contacts message.

name
WAContactName

Contact name.

phones
[JSON]

Phone numbers.

emails
[JSON]

Email addresses.

urls
[JSON]

URLs.

org
JSON

Organization info.

birthday
String

Birthday (YYYY-MM-DD).

addresses
[JSON]

Postal addresses.

Sample
{
  "name": {
    "__typename": "WAContactName"
  },
  "phones": [
    "Example Custom Scalar"
  ],
  "emails": [
    "Example Custom Scalar"
  ],
  "urls": [
    "Example Custom Scalar"
  ],
  "org": "Example Custom Scalar",
  "birthday": "Example String",
  "addresses": [
    "Example Custom Scalar"
  ]
}
Referenced in
ConversationMessage.contacts

WAContactName

A contact name structure (vCard-like).

formatted_name
String

Full formatted name.

first_name
String

First name.

last_name
String

Last name.

middle_name
String

Middle name.

prefix
String

Name prefix (e.g. 'Dr.').

suffix
String

Name suffix (e.g. 'Jr.').

Sample
{
  "formatted_name": "Example String",
  "first_name": "Example String",
  "last_name": "Example String",
  "middle_name": "Example String",
  "prefix": "Example String",
  "suffix": "Example String"
}
Referenced in
WAContact.name

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview