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

UnassignedPayload

Payload for unassigned action.

assignedTo
String
assignedUserId
String
assignedDepartmentId
String
assignedBy
String
performedBy
String
assignedToUser

Resolved user who was unassigned from.

assignedUser

Resolved user who was unassigned (by assignedUserId).

assignedByUser

Resolved user who performed the unassignment.

performedByUser

Resolved user who performed the action.

assignedDepartment

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

UntaggedPayload

Payload for untagged action.

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

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

WAContact

A shared contact from a WhatsApp contacts message.

Contact name.

phones

Phone numbers.

emails

Email addresses.

urls

URLs.

org

Organization info.

birthday
String

Birthday (YYYY-MM-DD).

addresses

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

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

WALocation

Location message content.

latitude
Float

Latitude.

longitude
Float

Longitude.

name
String

Location name/label.

address
String

Street address.

url
String

URL to open in maps.

Sample
{ "latitude": 40, "longitude": 40, "name": "Example String", "address": "Example String", "url": "Example String" }

WAReferral

WhatsApp ad referral data (click-to-WhatsApp ads).

source_url
String

Source URL of the ad.

source_type
String

Source type (e.g. 'ad').

source_id
String

Source identifier.

headline
String

Ad headline text.

body
String

Ad body text.

media_type
String

Media type of the ad ('image' or 'video').

image_url
String

Image URL from the ad.

video_url
String

Video URL from the ad.

thumbnail_url
String

Thumbnail URL from the ad.

Sample
{ "source_url": "Example String", "source_type": "Example String", "source_id": "Example String", "headline": "Example String", "body": "Example String", "media_type": "Example String", "image_url": "Example String", "video_url": "Example String", "thumbnail_url": "Example String" }

WASticker

Sticker message content.

id
String

Media ID.

link
String

Direct link to the sticker file.

url
String

Resolved URL for the sticker.

mime_type
String

MIME type (e.g. 'image/webp').

sha256
String

SHA-256 hash.

animated
Boolean

Whether this is an animated sticker.

Sample
{ "id": "Example String", "link": "Example String", "url": "Example String", "mime_type": "Example String", "sha256": "Example String", "animated": true }

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview