Skip to content
Developers/
Other
/
/
TemplateRenderedButton

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

ScoreCategoryEntry

Individual score category tracking (speed, quality, productivity, training, engagement).

score
Float
actions
Int
Sample
{
  "score": 40,
  "actions": 40
}
Referenced in
ScoreCategories.speed
ScoreCategories.quality
ScoreCategories.productivity
ScoreCategories.training
ScoreCategories.engagement

StatusChangedPayload

Payload for status_changed action.

from
String
to
String
status
String
performedBy
String
viaAutomation
Boolean
performedByUser
User

Resolved user who performed the status change.

Sample
{
  "from": "Example String",
  "to": "Example String",
  "status": "Example String",
  "performedBy": "Example String",
  "viaAutomation": true,
  "performedByUser": {
    "__typename": "User"
  }
}
Referenced in
ActionsPayload

Submission

_id
String!,non-null
contentTypeId
String
customerId
String
customer
Customer
createdAt
Date
customFieldsData
JSON
submissions
[FormSubmission]
Sample
{
  "_id": "Example String",
  "contentTypeId": "Example String",
  "customerId": "Example String",
  "customer": {
    "__typename": "Customer"
  },
  "createdAt": "Example Custom Scalar",
  "customFieldsData": "Example Custom Scalar",
  "submissions": [
    {
      "__typename": "FormSubmission"
    }
  ]
}
Referenced in
FormSubmissionListResponse.data

SuccessResult

success
Boolean
Sample
{
  "success": true
}

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

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview