Introduction
Welcome
Quickstart
Identifying Yourself as an App User
GraphQL
API
Working with GraphQL
Pagination
Common Api Queries
Introduction
List All Conversations
Fetch A Single Conversation
List All Contacts
Attaching a File to a Message
Webhooks
Introduction
Conversation created
Conversation opened
Conversation closed
Conversation assigned
Conversation snoozed
Message created
Message updated
Mention created
Channel user created
Conversation tag created
Conversation tag deleted
Channel user tag created
Channel user tag deleted
Chatbot flow started
Chatbot flow ended
Useful Scripts
Introduction
Finding A Single Conversation
Exporting All Conversations
Bulk Assigning Conversations to a Teammate
Queries
app
currentAppUser
Mutations
appUpdate
attachmentImageUploadFromUrl
attachmentUpload
attachmentUploadFromUrl
attachmentVideoUploadFromUrl
channelUserCreate
channelUserDataAttributeBoolUpdate
channelUserDataAttributeDateUpdate
channelUserDataAttributeDecimalUpdate
channelUserDataAttributeNumberUpdate
channelUserDataAttributeTextUpdate
channelUserIdentifierUpdate
channelUserTag
channelUserTagByTagId
channelUserUntag
channelUserUpdate
conversationAssign
conversationClose
conversationOpen
conversationSetState
conversationSnooze
conversationTag
conversationTagByTagId
conversationTeamAssign
conversationUnsnooze
conversationUntag
dataAttributeArchive
dataAttributeBatchCreate
dataAttributeCreate
gifMessageCreate
mediaMessageCreate
messageDelete
messageRetrySend
noteMessageCreate
richMessageCreate
sandboxAddTester
sandboxRemoveTester
templateMessageCreate
templateProactiveMessageCreate
templateSetActive
templateSubmit
templateUpdate
templatesSync
textMessageCreate
textProactiveMessageCreate
webhookSubscriptionCreate
webhookSubscriptionDestroy
webhookSubscriptionUpdate
Types
AbmInputObject
Account
AiSummaryMessage
AnimationMessage
App
AppConnection
AppEdge
AppUpdateInput
AppUser
AppUserConnection
AppUserEdge
AppUserNotificationMethodEnum
AppUserNotificationPreference
AppUserNotificationTypeEnum
AppUserPresenceEnum
AppUserRoleEnum
AppUserRolePermissionEnum
AppUserStatusEnum
AssignmentActionMessage
Attachment
AttachmentConnection
AttachmentEdge
AttachmentImageUploadFromUrlInput
AttachmentImageUploadFromUrlPayload
AttachmentTypeEnum
AttachmentUploadFromUrlInput
AttachmentUploadFromUrlPayload
AttachmentUploadInput
AttachmentUploadPayload
AttachmentVideoUploadFromUrlInput
AttachmentVideoUploadFromUrlPayload
AttributeInputObject
AudioMessage
Boolean
BotUser
BotUserConnection
BotUserEdge
CampaignFilterInputObject
CampaignQueryInputObject
Channel
ChannelConnection
ChannelEdge
ChannelHealthDefaultMetadata
ChannelHealthIssue
ChannelHealthIssueCategoryEnum
ChannelHealthIssueSeverityEnum
ChannelHealthMetadataWhatsappGatewayStatusEnum
ChannelHealthMetadataWhatsappPhoneStatusTypeEnum
ChannelHealthMetadataWhatsappQualityEnum
ChannelHealthMetadataWhatsappTierEnum
ChannelHealthStatus
ChannelHealthWhatsappMetadata
ChannelTypeEnum
ChannelUser
ChannelUserConnection
ChannelUserCreateInput
ChannelUserDataAttribute
ChannelUserDataAttributeArchiveInput
ChannelUserDataAttributeBatchCreateInput
ChannelUserDataAttributeConnection
ChannelUserDataAttributeCreateInput
ChannelUserDataAttributeEdge
ChannelUserEdge
ChannelUserFilterableCreatedAtInputObject
ChannelUserFilterableDataAttributeBoolInputObject
ChannelUserFilterableDataAttributeDateInputObject
ChannelUserFilterableDataAttributeDecimalInputObject
ChannelUserFilterableDataAttributeNumberInputObject
ChannelUserFilterableDataAttributeTextInputObject
ChannelUserFilterableEmailInputObject
ChannelUserFilterableNameInputObject
ChannelUserFilterableOptOutInputObject
ChannelUserFilterablePhoneInputObject
ChannelUserFilterableTagIdInputObject
ChannelUserIdentifierSourceEnum
ChannelUserIdentifierUpdateInput
ChannelUserNote
ChannelUserSourceIdentifier
ChannelUserTagByTagIdInput
ChannelUserTagInput
ChannelUserUntagInput
ChannelUserUpdateInput
ComponentButtonInputObject
ComponentInputObject
ContactEntry
ContactIm
ContactMessage
Conversation
ConversationAssignmentInput
ConversationAssignmentPayload
ConversationCloseInput
ConversationClosePayload
ConversationConnection
ConversationEdge
ConversationOpenInput
ConversationOpenPayload
ConversationParticipant
ConversationSetStateInput
ConversationSetStatePayload
ConversationSnoozeInput
ConversationSnoozePayload
ConversationStateEnum
ConversationTagByTagIdInput
ConversationTagInput
ConversationTeamAssignmentInput
ConversationTeamAssignmentPayload
ConversationUnsnoozeInput
ConversationUnsnoozePayload
ConversationUntagInput
DataAttribute
DataAttributeBoolType
DataAttributeBoolUpdateInput
DataAttributeDateType
DataAttributeDateUpdateInput
DataAttributeDecimalType
DataAttributeDecimalUpdateInput
DataAttributeNumberType
DataAttributeNumberUpdateInput
DataAttributeTextType
DataAttributeTextUpdateInput
DataAttributeTypeEnum
DeletedMessage
DocumentMessage
EmailMessageMeta
FacebookInputObject
Failure
FileInputObject
FilteringBooleanOperatorEnum
Float
HubspotContact
ImageMessage
InboxViewBooleanOperatorEnum
InboxViewFilterInputObject
InboxViewFilterableAssigneeIdInputObject
InboxViewFilterableChannelIdInputObject
InboxViewFilterableChannelTypeInputObject
InboxViewFilterableConversationIdInputObject
InboxViewFilterableConversationStateInputObject
InboxViewFilterableCreatedAtInputObject
InboxViewFilterableLastMessageAtInputObject
InboxViewFilterableParticipantInputObject
InboxViewFilterableSnoozedUntilInputObject
InboxViewFilterableTagIdInputObject
InboxViewFilterableTeamIdInputObject
InboxViewMessagingWindowInputObject
InboxViewQueryInputObject
InstagramInputObject
Int
InteractiveMessage
InteractiveMessageHeader
InteractiveMessageMediaHeader
InteractiveMessageTextHeader
List
ListMessage
ListSection
ListSectionRow
LocationMessage
MdString
Mention
MentionConnection
MentionEdge
Message
MessageCategoryEnum
MessageConnection
MessageContactIMTypeEnum
MessageDeleteInput
MessageDeletePayload
MessageDirectionEnum
MessageEdge
MessageFacebookTagEnum
MessageGifCreateInput
MessageGifCreatePayload
MessageInstagramTagEnum
MessageMediaCreateInput
MessageMediaCreatePayload
MessageNoteCreateInput
MessageNoteCreatePayload
MessageProactiveTemplateCreateInput
MessageProactiveTemplateCreatePayload
MessageProactiveTextCreateInput
MessageProactiveTextCreatePayload
MessageQuickReplyTypeEnum
MessageRetrySendInput
MessageRetrySendPayload
MessageRichCreateInput
MessageRichCreatePayload
MessageSubTypeEnum
MessageTemplate
MessageTemplateCategoryEnum
MessageTemplateComponent
MessageTemplateComponentButton
MessageTemplateComponentButtonTypeEnum
MessageTemplateComponentFormatEnum
MessageTemplateComponentTypeEnum
MessageTemplateConnection
MessageTemplateCreateInput
MessageTemplateCreatePayload
MessageTemplateCreationComponentInputObject
MessageTemplateCreationComponentParameterInputObject
MessageTemplateCreationComponentParameterTypeEnum
MessageTemplateCreationComponentSubtypeEnum
MessageTemplateEdge
MessageTemplateLanguageEnum
MessageTemplateSetActiveInput
MessageTemplateSetActivePayload
MessageTemplateStateEnum
MessageTemplateSubmitInput
MessageTemplateSubmitPayload
MessageTemplateUpdateInput
MessageTemplateUpdatePayload
MessageTemplatesSyncInput
MessageTemplatesSyncPayload
MessageTextCreateInput
MessageTextCreatePayload
MessageTypeEnum
MessageWindowExpiryCondition
MessageWindowExpiryConditionEnum
MessagingWindowStatusTypeEnum
MetadataTypeUnion
Mutation
NoteMessage
PageInfo
Phone
PinnedMessage
PlatformWebhookSubscriptionCreateInput
PlatformWebhookSubscriptionDestroyInput
PlatformWebhookSubscriptionDestroyPayload
PlatformWebhookSubscriptionUpdateInput
Query
QuickReply
QuickReplyInputObject
QuickReplyMessage
RichMessage
Role
SandboxAddTesterInput
SandboxAddTesterPayload
SandboxConnectedTester
SandboxRemoveTesterInput
SandboxRemoveTesterPayload
SavedReply
SavedReplyConnection
SavedReplyEdge
SavedReplyFolder
SavedReplyLeafUnion
Shift
SnoozeActionMessage
StateActionMessage
String
Tag
TagConnection
TagEdge
Team
TeamDayScheduleType
TeamMembership
TeamScheduleType
TeamsAssignmentOptionEnum
TemplateMessage
TextMessage
UnsnoozeActionMessage
UnsupportedMessage
UploadInformation
Url
User
VideoMessage
WebhookEventTypeEnum
WebhookSubscription
WebhookSubscriptionConnection
WebhookSubscriptionEdge
WeekDaysEnum
WorkspaceUserUnion
TeamScheduleType
Object
Fields
#
days
[
TeamDayScheduleType
!]!
Non-null
timezone
String
!
Non-null
Usages
#
References
#
Field
schedule
from
Team
Previous
TeamMembership
Next
TeamsAssignmentOptionEnum