GraphQL API
Overview
Queries
closedConversations
connectedUsersIndicator
connectorConversationClosingFormValues
connectorVersion
connectors
conversation
conversationTag
conversationTags
conversion
conversions
engagementCampaign
engagementCampaignsV2
knowledgeSource
metrics
productionIndicator
professionalBaseRoles
professionalRoles
project
projects
routingGroup
routingGroups
routingGroupsV2
routingRule
routingRules
routingRulesV2
satisfactionSurveyResponses
searchClosedConversations
skill
skills
user
userGroups
users
visitor
visitorConversationCustomData
visitorCustomData
visitors
Mutations
authenticatedMessagingSettingsSet
chatbotMessageSend
closedConversationAnonymize
conversationCustomDataSet
conversationTagCreate
knowledgeFAQsDelete
knowledgeFAQsUpsert
knowledgeProductsDelete
knowledgeProductsUpsert
knowledgeSourceCreate
professionalCreate
professionalSetExternalId
professionalSetGroup
professionalSetProjects
professionalSetSkills
professionalUnsetExternalId
professionalUnsetGroup
professionalUpdate
routingGroupCreate
routingGroupDelete
routingGroupUpdate
routingRuleCreate
routingRuleDelete
routingRuleUpdate
skillCreate
skillDelete
skillUpdate
smsOutboundMessageSend
testVisitorAuthenticateFromCredentials
userAvailabilityStatusUpdate
userCancelExtendedPresence
userCreate
userDelete
userSkillsAdd
userSkillsRemove
userSkillsSet
userUpdate
visitorAnonymize
whatsAppOutboundMessageSend
Types
AnswersAssistanceSettings
AppleBusinessChatMessageExtensionAttachment
ApplePayContactField
ApplePayLineItemAttachmentType
ApplePayLineItemType
ApplePayPaymentAttachment
ApplePayPaymentRequestedAttachment
ApplePayShippingMethodAttachmentType
AuthenticatedMessagingSettings
AuthenticatedMessagingSettingsInput
AuthenticationRequestedAttachment
AutomaticMessageSentSystemAttachment
AutomationLevel
Boolean
Bot
BotRole
CallConfiguration
CallConfigurationInput
CallConfigurationUpdate
CallSettings
CannedAnswersCategorySortingOrder
CannedAnswersSortingOrder
CannotChangeOwnRoleProfessionalUpdateUserError
CardAttachment
CardBundleAttachment
CardBundleAttachmentActionType
Category
Channel
ChannelAvailabilityStatus
ChannelConfiguration
ChannelConfigurationInput
ChannelConfigurationUpdate
ChannelGroupAvailabilityStatus
ChatAndCallWithDisabledCallError
ChatConfiguration
ChatConfigurationInput
ChatConfigurationUpdate
ChatToVideoWithDisabledVideoError
ChatbotActionAttachmentInput
ChatbotActionInput
ChatbotActionOrMessageInput
ChatbotCardAttachmentInput
ChatbotCardBundleAttachmentInput
ChatbotConversationMessageAttachmentInput
ChatbotFileAttachmentInput
ChatbotImageAttachmentInput
ChatbotLinkActionAttachmentInput
ChatbotMessageInput
ChatbotMessageSendErrors
ChatbotMessageSendInput
ChatbotMessageSendPayload
ChatbotMimeTypeInput
ChatbotNotInConversationError
ChatbotProductOfferAttachmentInput
ChatbotProductOfferBundleAttachmentInput
ChatbotQuickReplyMenuAttachmentInput
Client
CloseMessageInput
CloseReason
ClosedConversationAnonymizeInputType
ClosedConversationAnonymizePayload
ClosedConversationFilters
ClosedConversationsResultConnection
ClosedConversationsResultEdge
ClosedConversationsResultType
ClosingFormValue
CommunitySettings
ConnectedUserFilters
ConnectedUsersIndicator
Connector
ConnectorConnection
ConnectorConversationClosingFormValue
ConnectorEdge
ConnectorScreenshot
ConnectorVersion
ConnectorVersionParameter
ConnectorVersionParameterType
ConnectorVersionParameterValue
ConnectorVersionParameterValueText
ConnectorVersionStatus
ContextualInfosAttachment
Conversation
ConversationAssignment
ConversationBlockedAttachment
ConversationClosedError
ConversationClosedStatus
ConversationClosedSystemAttachment
ConversationConversationCustomDataEntry
ConversationCustomData
ConversationCustomDataEntryBoolean
ConversationCustomDataEntryFloat
ConversationCustomDataEntryInt
ConversationCustomDataEntryString
ConversationCustomDataInput
ConversationCustomDataSetInput
ConversationCustomDataSetPayload
ConversationDistributionStatus
ConversationMessage
ConversationMessageAttachment
ConversationMessageAttachmentAction
ConversationMessageAttachmentImageLink
ConversationMessageAttachmentLinkAction
ConversationMessageAttachmentSelectAction
ConversationMessageConnection
ConversationMessageEdge
ConversationNotFoundError
ConversationNotReadyError
ConversationParticipant
ConversationPendingStatus
ConversationPushedStatus
ConversationPushedSystemAttachment
ConversationReleasedSystemAttachment
ConversationSessionType
ConversationSnoozedStatus
ConversationSnoozedSystemAttachment
ConversationStarterSent
ConversationTag
ConversationTagConnection
ConversationTagEdge
ConversationTagInput
ConversationTagSettings
ConversationTagUserType
ConversationTransferredError
ConversationVisitor
ConversationVisitorConnection
ConversationVisitorEdge
Conversion
ConversionConnection
ConversionEdge
ConversionSource
Conversions
CountryPreferences
CountryPreferencesInput
CountryPreferencesUpdateInput
Currency
Date
DateFormat
DateTime
Developer
DeveloperRole
Duration
DynamicSetConfiguration
DynamicSetConfigurationInput
EmailAlreadyUsedError
EmailAlreadyUsedProfessionalCreateUserError
EmailAlreadyUsedProfessionalUpdateUserError
EngagementCampaign
EngagementCampaignRuleSource
EngagementCampaignState
EngagementCampaignType
EngagementCampaignV2Connection
EngagementCampaignV2Edge
EngagementRuleTriggeredSystemAttachment
EscalationAcceptedAttachment
EscalationEndReason
EscalationEndedAttachment
EscalationInvitationSentAttachment
EscalationType
Expert
ExpertRole
ExternalIdIsEmptyError
ExternalIdIsEmptyProfessionalCreateUserError
ExternalIdIsEmptyProfessionalSetExternalIdUserError
FAQApiSyncInputType
FAQStatus
FailedApplePayPaymentResponseAttachment
FailedAuthenticationResponseAttachment
FeedbackRequested
FeedbackRequestedReason
FeedbackSent
FeedbackValue
FileAttachment
FileBundleAttachment
FirstNameIsEmptyError
FirstNameIsEmptyProfessionalCreateUserError
FirstNameIsEmptyProfessionalUpdateUserError
Float
HungUpAttachment
IbbuManager
IbbuManagerRole
ImageAttachment
IncompatibleAskForNumberChoiceError
Int
Interval
InvalidAvatarURLProfessionalCreateUserError
InvalidAvatarUrlError
InvalidEmailError
InvalidEmailProfessionalCreateUserError
InvalidEmailProfessionalUpdateUserError
InvalidGroupIdError
InvalidGroupIdProfessionalCreateUserError
InvalidGroupIdProfessionalSetGroupUserError
InvalidInterfaceLanguageError
InvalidInterfaceLanguageProfessionalCreateUserError
InvalidInterfaceLanguageProfessionalUpdateUserError
InvalidNumberOfSlotsForChatError
InvalidNumberOfSlotsForThirdPartiesError
InvalidPasswordError
InvalidPasswordProfessionalCreateUserError
InvalidPasswordProfessionalUpdateUserError
InvalidPhoneNumberError
InvalidPriorityValueError
InvalidProjectIdError
InvalidProjectIdProfessionalCreateUserError
InvalidProjectIdProfessionalSetProjectsUserError
InvalidRoleError
InvalidRoleProfessionalCreateUserError
InvalidRoleProfessionalUpdateUserError
InvalidSkillIdError
InvalidSkillIdProfessionalCreateUserError
InvalidSkillIdProfessionalSetSkillsUserError
InvalidSpokenLanguageError
InvalidSpokenLanguageProfessionalCreateUserError
InvalidSpokenLanguageProfessionalUpdateUserError
KnowledgeFAQInput
KnowledgeFAQStatus
KnowledgeFAQsDeleteInput
KnowledgeFAQsDeletePayload
KnowledgeFAQsUpsertInput
KnowledgeFAQsUpsertPayload
KnowledgeProductAvailability
KnowledgeProductCondition
KnowledgeProductGender
KnowledgeProductInput
KnowledgeProductStatus
KnowledgeProductsDeleteInput
KnowledgeProductsDeletePayload
KnowledgeProductsUpsertInput
KnowledgeProductsUpsertPayload
KnowledgeSource
KnowledgeSourceCreateInput
KnowledgeSourceCreatePayload
KnowledgeSourceDetails
KnowledgeSourceDetailsInput
KnowledgeSourceFAQApiSync
KnowledgeSourceProductApiSync
KnowledgeSourceStatus
KnowledgeSourceStatusProcessing
KnowledgeSourceStatusReady
KnowledgeSourceStatusUnexpectedError
Language
LastNameIsEmptyError
LastNameIsEmptyProfessionalCreateUserError
LastNameIsEmptyProfessionalUpdateUserError
LegacyId
LinkAttachment
LinkCategorySortingOrder
LinkSettings
LinkSortingOrder
ListPickerAttachment
ListPickerAttachmentItem
ListPickerAttachmentSection
ListPickerResponseAttachment
LiveAgentRequestedAttachment
Locale
Location
LocationAttachment
LocationCoordinatesOrigin
LocationCreateInput
LocationUpdateInput
Long
MessageTranslation
MessengerFont
MessengerFontConnection
MessengerFontEdge
MetricAgentAvailability
MetricAgentAvailabilityFiltersInput
MetricAgentAvailabilityGroupByFieldInput
MetricAgentAvailabilityGroupByInput
MetricAgentAvailabilityInput
MetricAgentAvailabilityName
MetricAgentGroupAvailability
MetricAgentGroupAvailabilityFiltersInput
MetricAgentGroupAvailabilityGroupByInput
MetricAgentGroupAvailabilityInput
MetricAgentGroupAvailabilityName
MetricAgentGroupsAvailabilityGroupByFieldInput
MetricContactOpportunities
MetricContactOpportunitiesFiltersInput
MetricContactOpportunitiesGroupByFieldInput
MetricContactOpportunitiesGroupByInput
MetricContactOpportunitiesInput
MetricContactOpportunitiesName
MetricContacts
MetricContactsFiltersInput
MetricContactsGroupByFieldInput
MetricContactsGroupByInput
MetricContactsInput
MetricContactsName
MetricGranularity
MetricGroupedItem
MetricTargetingRules
MetricTargetingRulesFiltersInput
MetricTargetingRulesGroupByFieldInput
MetricTargetingRulesGroupByInput
MetricTargetingRulesInput
MetricTargetingRulesName
MetricTransactions
MetricTransactionsFiltersInput
MetricTransactionsGroupByFieldInput
MetricTransactionsGroupByInput
MetricTransactionsInput
MetricTransactionsName
Metrics
MirroringSettings
Mutation
NavigationChangedSystemAttachment
NotAProfessionalUserIdProfessionalSetExternalIdUserError
NotAProfessionalUserIdProfessionalSetGroupUserError
NotAProfessionalUserIdProfessionalSetProjectsUserError
NotAProfessionalUserIdProfessionalSetSkillsUserError
NotAProfessionalUserIdProfessionalUnsetExternalIdUserError
NotAProfessionalUserIdProfessionalUnsetGroupUserError
NotAProfessionalUserIdProfessionalUpdateUserError
NotesSettings
NotificationSettings
OfferAttachment
OfferCategorySortingOrder
OfferSettings
OfferSortingOrder
OpenConversationFilters
OrderBy
OutboundMessageResponse
OutboundMessageSentSystemAttachment
OutboundMessageVariable
PageInfo
ParticipantConversationMessage
PhoneNumber
PhoneNumberCountryCode
PickedUpAttachment
PriceType
ProductApiSyncInput
ProductAttachment
ProductDetails
ProductOfferAttachment
ProductOfferBundleAttachment
ProductStatus
ProductionIndicator
ProductionOpenConversationStatus
Professional
ProfessionalBaseRoleName
ProfessionalCreateInput
ProfessionalCreatePayload
ProfessionalCreateUserError
ProfessionalPermission
ProfessionalRole
ProfessionalRoleConnection
ProfessionalRoleEdge
ProfessionalRolePermission
ProfessionalRolePermissionConnection
ProfessionalRolePermissionEdge
ProfessionalRoleWithPermissions
ProfessionalSetExternalIdInput
ProfessionalSetExternalIdPayload
ProfessionalSetExternalIdUserError
ProfessionalSetGroupInput
ProfessionalSetGroupPayload
ProfessionalSetGroupUserError
ProfessionalSetProjectsInput
ProfessionalSetProjectsPayload
ProfessionalSetProjectsUserError
ProfessionalSetSkillsInput
ProfessionalSetSkillsPayload
ProfessionalSetSkillsUserError
ProfessionalUnsetExternalIdInput
ProfessionalUnsetExternalIdPayload
ProfessionalUnsetExternalIdUserError
ProfessionalUnsetGroupInput
ProfessionalUnsetGroupPayload
ProfessionalUnsetGroupUserError
ProfessionalUpdateInput
ProfessionalUpdatePayload
ProfessionalUpdateUserError
Project
ProjectConnection
ProjectEdge
ProjectSettings
PseudoIsEmptyProfessionalCreateUserError
PseudoIsEmptyProfessionalUpdateUserError
Query
QuickReplyMenuAttachment
RespondFrom
RespondentType
ResumeMessageSentSystemAttachment
RoutingEvent
RoutingGroup
RoutingGroupConnection
RoutingGroupEdge
RoutingGroupInput
RoutingMode
RoutingModeCustom
RoutingModeCustomInput
RoutingModeCustomPercentage
RoutingModeCustomPercentageInput
RoutingModeDynamic
RoutingModeDynamicInput
RoutingModeEscalation
RoutingModeEscalationInput
RoutingModeFair
RoutingModeFairInput
RoutingModeInput
RoutingModeReactive
RoutingModeReactiveInput
RoutingRule
RoutingRuleAvailability
RoutingRuleChannelAvailability
RoutingRuleConnection
RoutingRuleEdge
RoutingRuleInput
RoutingRuleRoutingGroupConnection
RoutingRuleRoutingGroupEdge
RoutingRuleSlots
RoutingRuleSlotsInput
RoutingRuleTargetingRuleInput
RoutingSegment
RoutingSegmentInput
RoutingSegmentLogicalOperator
RoutingSegmentUserDynamic
RoutingSegmentUserGroups
RoutingSegmentUserGroupsInput
RoutingSegmentUserIds
RoutingSegmentUserIdsInput
RoutingSegmentUserRoles
RoutingSegmentUserRolesInput
RoutingSegmentUserSkills
RoutingSegmentUserSkillsInput
RoutingUserRole
SAMLUserIdAlreadyUsedError
SAMLUserIdAlreadyUsedProfessionalCreateUserError
SAMLUserIdIsEmptyError
SAMLUserIdIsEmptyProfessionalCreateUserError
SMSOutboundSendMessage
SatisfactionConversation
SatisfactionSurvey
SatisfactionSurveyResponse
SatisfactionSurveyResponseNode
SatisfactionSurveyResponses
SatisfactionSurveyResponsesPageInfo
SearchClosedConversationsFilters
SearchClosedConversationsResult
SearchClosedConversationsResultConnection
SearchClosedConversationsResultEdge
Skill
SkillConnection
SkillCreateInput
SkillCreateOrUpdatePayload
SkillDeleteInput
SkillDeletePayload
SkillEdge
SkillUpdateInput
Source
StatsAvailabilityStatus
String
SuccessfulApplePayPaymentResponseAttachment
SuccessfulAuthenticationResponseAttachment
SuggestedReplies
SuggestedReply
SuggestedReplySent
SupervisorCommentSentSystemAttachment
SurveyMessageSystemAttachment
SurveyMultiChoiceQuestionSystemAttachment
SurveyQuestionSystemAttachment
SystemConversationMessageAttachment
SystemMessage
TargetingRule
ThirdPartyAccount
ThirdPartyConfiguration
ThirdPartyConfigurationInput
ThirdPartyConfigurationUpdate
TimeFormat
TimePickerAttachment
TimePickerResponseAttachment
TimeSlotAttachment
Transaction
TransferMessageInput
TransferOptionsInput
TransferredToRoutingRuleSystemAttachment
TransferredToUserSystemAttachment
URI
URL
UUID
UnsupportedAttachment
UnsupportedSystemMessageAttachment
User
UserAvailability
UserAvailabilityChannel
UserAvailabilityInput
UserAvailabilityPayload
UserAvailabilityStatus
UserCancelExtendedPresencePayload
UserChannelAvailability
UserConnection
UserCreateInput
UserCreatePayload
UserDeleteError
UserDeleteInput
UserDeletePayload
UserEdge
UserError
UserGroup
UserGroupsConnection
UserGroupsEdge
UserHasOngoingConversationsUserDeleteError
UserMutationErrors
UserNameIsEmptyError
UserPresence
UserProjectConnection
UserProjectEdge
UserRole
UserUpdateInput
UserUpdatePayload
UsersInProductionOccupancy
VideoAttachment
VideoConfiguration
VideoConfigurationInput
VideoConfigurationUpdate
Visitor
VisitorAnonymizeInput
VisitorAnonymizePayload
VisitorAuthenticateFromCredentialsInput
VisitorAuthenticateFromCredentialsPayload
VisitorBlockedSystemAttachment
VisitorConversationCustomData
VisitorConversationCustomDataEntry
VisitorConversationCustomDataEntryBoolean
VisitorConversationCustomDataEntryFloat
VisitorConversationCustomDataEntryInt
VisitorConversationCustomDataEntryString
VisitorCustomData
VisitorCustomDataBoolean
VisitorCustomDataFloat
VisitorCustomDataInt
VisitorCustomDataString
VisitorLeftSystemAttachment
VisitorNotificationSettingsConfirmedSystemAttachment
VisitorNotificationSettingsRequestedSystemAttachment
VisitorNotificationSettingsSetSystemAttachment
VisitorReturnedSystemAttachment
VisitorSessionToken
VisitorsConnection
VisitorsEdge
WhatsAppOutboundSendMessage
ZoneId
Date
Scalar
ISO-8601 compliant date format
Previous
Currency
Next
DateFormat
