Mutations
#
affiliatesClickCreateType: ClickCreatePayload
No description
#
Input fieldsinput
(ClickCreateInput!
)
#
agentNotificationPreferenceBulkDeleteType: AgentNotificationPreferenceBulkDeletePayload
Deletes agent notification preferences.
#
Input fields#
agentNotificationPreferenceBulkUpsertType: AgentNotificationPreferenceBulkUpsertPayload
Creates or updates agent notification preferences.
#
Input fields#
agentPreferenceDeleteType: AgentPreferenceDeletePayload
Deletes agent preferences.
#
Input fieldsinput
(AgentPreferenceDeleteInput!
)
#
agentPreferenceUpsertType: AgentPreferenceUpsertPayload
Creates or updates agent preferences.
#
Input fieldsinput
(AgentPreferenceUpsertInput!
)
#
agentResetLoginAttemptsType: AgentResetLoginAttemptsPayload
#
Input fieldsinput
(AgentResetLoginAttemptsInput!
)
#
agentResetPasswordType: AgentResetPasswordPayload
#
Input fieldsinput
(AgentResetPasswordInput!
)
#
agentSendAdminEmailNotificationType: AgentSendAdminEmailNotificationPayload
#
Input fieldsinput
(AgentSendAdminEmailNotificationInput!
)
#
aiConversationSuggestionUpsertType: SuggestionUpsertPayload
No description
#
Input fieldsinput
(SuggestionUpsertInput!
)
#
asyncRpcType: AsyncRpcPayload
No description
#
Input fieldsinput
(AsyncRpcInput!
)
#
cancelDowngradeType: CancelDowngradePayload
#
Input fieldsinput
(CancelDowngradeInput!
)
#
cardSetupIntentCreateType: CardSetupIntentCreatePayload
#
Input fieldsinput
(CardSetupIntentCreateInput!
)
#
cardSetupIntentSucceedType: CardSetupIntentSucceedPayload
#
Input fieldsinput
(CardSetupIntentSucceedInput!
)
#
channelDeleteType: ChannelDeletePayload
Deletes an existing channel from the Inbox.
Example usage:
#
Input fieldsinput
(ChannelDeleteInput!
)
#
channelDisconnectType: DisconnectMutationPayload
No description
#
Input fieldsinput
(DisconnectMutationInput!
)
#
channelEmailCreateType: EmailChannelCreatePayload
Creates a new email channel in the inbox.
Example usage:
#
Input fieldsinput
(EmailChannelCreateInput!
)
#
channelEmailUpdateType: EmailChannelUpdatePayload
Update an existing Inbox email channel.
Example usage:
#
Input fieldsinput
(EmailChannelUpdateInput!
)
#
channelImportType: ImportMutationPayload
No description
#
Input fieldsinput
(ImportMutationInput!
)
#
checkAccessByMatrixIdsType: CheckAccessByMatrixIdsPayload
Returns the provided list of Matrix room IDs with a flag indicating the ability of the current use to access each of them.
#
Input fieldsinput
(CheckAccessByMatrixIdsInput!
)
#
companyAddContactsType: CompanyAddContactsPayload
Adds contacts to a company.
For example:
#
Input fieldsinput
(CompanyAddContactsInput!
)
#
companyCreateType: CompanyCreatePayload
Creates a company.
For example:
#
Input fieldsinput
(CompanyCreateInput!
)
#
companyDeleteType: CompanyDeletePayload
Deletes a company.
For example:
#
Input fieldsinput
(CompanyDeleteInput!
)
#
companyMergeType: CompanyMergePayload
Merges one company (the source) into another company (the target). The target company is preserved, and the source company is deleted.
The fields in keepFieldIds
from the source company will be preserved
in the merge, and will be merged into the destination company.
#
Input fieldsinput
(CompanyMergeInput!
)
#
companyRemoveContactsType: CompanyRemoveContactsPayload
Remove contacts from a company.
For example:
#
Input fieldsinput
(CompanyRemoveContactsInput!
)
#
contactCreateType: ContactCreatePayload
Creates a contact.
For example:
#
Input fieldsinput
(ContactCreateInput!
)
#
contactDeleteType: ContactDeletePayload
Deletes a contact permanently.
#
Input fieldsinput
(ContactDeleteInput!
)
#
contactMergeType: ContactMergePayload
Merges one contact (the source) into another contact (the target). The target contact is preserved, and the source contact is deleted.
The fields in keepFieldIds
from the source contact will be preserved
in the merge, and will be merged into the destination contact.
#
Input fieldsinput
(ContactMergeInput!
)
#
contactResyncType: ContactResyncPayload
Updates a contact.
#
Input fieldsinput
(ContactResyncInput!
)
#
contactUpdateType: ContactUpdatePayload
Updates a contact.
#
Input fieldsinput
(ContactUpdateInput!
)
#
conversationAddNoteType: conversationAddNotePayload
Create a note in a conversation.
#
Input fieldsinput
(conversationAddNoteInput!
)
#
conversationAssignType: ConversationAssignPayload
Assigns a conversation to an agent, a team, or both.
For example:
To unassign a conversation see conversationUnassign
.
#
Input fieldsinput
(ConversationAssignInput!
)
#
conversationBulkDeleteType: ConversationBulkDeletePayload
Deletes any number of conversations. Conversations can be either soft deleted or hard deleted.
#
Input fieldsinput
(ConversationBulkDeleteInput!
)
#
conversationChangeChannelType: ConversationChangeChannelPayload
Move a conversation to another channel.
#
Input fieldsinput
(ConversationChangeChannelInput!
)
#
conversationChangeContactType: ConversationChangeContactPayload
Change the contact associated with a conversation.
For example:
#
Input fieldsinput
(ConversationChangeContactInput!
)
#
conversationCloseType: ConversationClosePayload
Sets a conversation's state to CLOSED
.
For example:
#
Input fieldsinput
(ConversationCloseInput!
)
#
conversationCreateEmailType: ConversationCreateEmailPayload
Creates a new email conversation.
For example:
#
Input fieldsinput
(ConversationCreateEmailInput!
)
#
conversationDeleteType: ConversationDeletePayload
Deletes up to 25 conversations. Conversations can be either soft deleted or hard deleted.
To trash (soft delete) conversations:
To permanently delete conversations:
#
Input fieldsinput
(ConversationDeleteInput!
)
#
conversationDeleteNoteType: conversationDeleteNotePayload
Delete note for comment
#
Input fieldsinput
(conversationDeleteNoteInput!
)
#
conversationEditNoteType: conversationEditNotePayload
Edit a note in a conversation.
#
Input fieldsinput
(conversationEditNoteInput!
)
#
conversationFollowType: ConversationFollowPayload
Adds one or more agents as followers to a conversation.
For example:
To unfollow a conversation see conversationUnfollow
.
#
Input fieldsinput
(ConversationFollowInput!
)
#
conversationForwardType: ConversationForwardPayload
Forwards a conversation.
#
Input fieldsinput
(ConversationForwardInput!
)
#
conversationForwardV2Type: ConversationForwardV2Payload
Forwards a conversation.
#
Input fieldsinput
(ConversationForwardV2Input!
)
#
conversationLinkResourceType: conversationLinkResourcePayload
Link an integration resource to the conversation
#
Input fieldsinput
(conversationLinkResourceInput!
)
#
conversationLogType: ConversationLogPayload
Creates a new conversation starting with a note.
#
Input fieldsinput
(ConversationLogInput!
)
#
conversationMergeType: ConversationMergePayload
Merges one conversation (the source) into another conversation (the target). The target conversation is preserved, and the source conversation is deleted.
For example:
#
Input fieldsinput
(ConversationMergeInput!
)
#
conversationMoveMessageType: ConversationMoveMessagePayload
Moves a message out of a conversation to create a new conversation.
#
Input fieldsinput
(ConversationMoveMessageInput!
)
#
conversationOpenType: ConversationOpenPayload
Sets a conversation's state to OPENED
.
For example:
#
Input fieldsinput
(ConversationOpenInput!
)
#
conversationReplyType: ConversationReplyPayload
Replies to a conversation.
#
Input fieldsinput
(ConversationReplyInput!
)
#
conversationRestoreType: conversationRestorePayload
Restores up to 25 soft-deleted conversations.
#
Input fieldsinput
(conversationRestoreInput!
)
#
conversationSnoozeType: ConversationSnoozePayload
Snoozes a conversation. Conversations can be either snoozed until a specific date or indefinitely.
For example:
To unsnooze and reopen a conversation use conversationOpen
.
To unsnooze a conversation while keeping it closed use conversationClose
.
#
Input fieldsinput
(ConversationSnoozeInput!
)
#
conversationSpamType: ConversationSpamPayload
Marks the conversation as spam.
For example:
#
Input fieldsinput
(ConversationSpamInput!
)
#
conversationStarType: ConversationStarPayload
Stars a conversation.
For example:
To unstar a conversation see conversationUnstar
,
#
Input fieldsinput
(ConversationStarInput!
)
#
conversationSubjectType: ConversationSubjectPayload
Updates the conversation subject.
For example:
#
Input fieldsinput
(ConversationSubjectInput!
)
#
conversationTagType: ConversationTagPayload
Add one or more tags to a Conversation.
For example:
To untag a conversation see conversationUntag
.
#
Input fieldsinput
(ConversationTagInput!
)
#
conversationToggleNoteReactionType: conversationToggleNoteReactionPayload
Toggle note reaction for comment
#
Input fieldsinput
(conversationToggleNoteReactionInput!
)
#
conversationTrashType: ConversationTrashPayload
Sets a conversation's state to DELETED
.
For example:
#
Input fieldsinput
(ConversationTrashInput!
)
#
conversationUnassignType: ConversationUnassignPayload
Unassigns a conversation from an agent, a team, or both.
For example:
To assign a conversation see conversationAssign
.
#
Input fieldsinput
(ConversationUnassignInput!
)
#
conversationUndoSendType: conversationUndoSendPayload
Undo the sending of a new conversation, reply or forward.
#
Input fieldsinput
(conversationUndoSendInput!
)
#
conversationUnfollowType: ConversationUnfollowPayload
Removes one or more agents as followers from a conversation.
For example:
To follow a conversation see conversationFollow
.
#
Input fieldsinput
(ConversationUnfollowInput!
)
#
conversationUnreadType: ConversationUnreadPayload
Sets a conversation's state to UNREAD
.
For example:
#
Input fieldsinput
(ConversationUnreadInput!
)
#
conversationUnstarType: ConversationUnstarPayload
Unstars a conversation.
For example:
To star a conversation see conversationStar
,
#
Input fieldsinput
(ConversationUnstarInput!
)
#
conversationUntagType: ConversationUntagPayload
Removes one or more tags from a conversation.
For example:
To tag a conversation see conversationTag
.
#
Input fieldsinput
(ConversationUntagInput!
)
#
customFieldCategoryCreateType: CustomFieldCategoryCreatePayload
Creates a custom field category.
#
Input fieldsinput
(CustomFieldCategoryCreateInput!
)
#
customFieldCategoryDeleteType: CustomFieldCategoryDeletePayload
Deletes a custom field category.
#
Input fieldsinput
(CustomFieldCategoryDeleteInput!
)
#
customFieldCategoryUpdateType: CustomFieldCategoryUpdatePayload
Updates a custom field category.
#
Input fieldsinput
(CustomFieldCategoryUpdateInput!
)
#
customFieldCreateType: CustomFieldCreatePayload
Creates a custom field.
#
Input fieldsinput
(CustomFieldCreateInput!
)
#
customFieldDeleteType: CustomFieldDeletePayload
Deletes a custom field.
#
Input fieldsinput
(CustomFieldDeleteInput!
)
#
customFieldOptionDeleteType: CustomFieldOptionDeletePayload
Deletes a custom field option.
#
Input fieldsinput
(CustomFieldOptionDeleteInput!
)
#
customFieldRemoveType: CustomFieldRemovePayload
Removes a custom field from a contact or company.
#
Input fieldsinput
(CustomFieldRemoveInput!
)
#
customFieldRestoreType: customFieldRestorePayload
No description
#
Input fieldsinput
(customFieldRestoreInput!
)
#
customFieldUpdateType: CustomFieldUpdatePayload
Updates a custom field.
#
Input fieldsinput
(CustomFieldUpdateInput!
)
#
customFieldValuesBulkUpdateType: CustomFieldValuesBulkUpdatePayload
Updates multiple contact or company custom fields in one go.
This is important if, for example, you want to constantly synchronize your contacts with an external data source.
Changes will be proccessed asynchronously in the background.
#
Input fieldsinput
(CustomFieldValuesBulkUpdateInput!
)
#
customFieldValuesUpdateType: CustomFieldValuesUpdatePayload
Creates, updates, or deletes custom field values for a contact or company.
Example request, with payload in the payload.json file:
Example payload.json file:
#
Input fieldsinput
(CustomFieldValuesUpdateInput!
)
#
customerRatingSettingDeleteType: CustomerRatingSettingDeletePayload
No description
#
Input fieldsinput
(CustomerRatingSettingDeleteInput!
)
#
customerRatingSettingUpsertType: CustomerRatingSettingUpsertPayload
No description
#
Input fieldsinput
(CustomerRatingSettingUpsertInput!
)
#
draftDeleteType: DraftDeletePayload
Deletes a draft.
For example:
#
Input fieldsinput
(DraftDeleteInput!
)
#
draftSaveType: DraftSavePayload
DEPRECATED Please use DraftUpsert.Creates or updates a draft.
For example:
#
Input fieldsinput
(DraftSaveInput!
)
#
draftUpsertType: DraftUpsertPayload
Upserts a draft
For example:
#
Input fieldsinput
(DraftUpsertInput!
)
#
emailMarketingSubscriptionCreateType: EmailMarketingSubscriptionCreatePayload
No description
#
Input fieldsinput
(EmailMarketingSubscriptionCreateInput!
)
#
emailMarketingSubscriptionDeleteType: EmailMarketingSubscriptionDeletePayload
No description
#
Input fieldsinput
(EmailMarketingSubscriptionDeleteInput!
)
#
eventsShopifyCreateType: EventsShopifyCreatePayload
#
Input fieldsinput
(EventsShopifyCreateInput!
)
#
excludedDomainCreateType: ExcludedDomainCreatePayload
Creates an excluded domain.
#
Input fieldsinput
(ExcludedDomainCreateInput!
)
#
excludedDomainDeleteType: ExcludedDomainDeletePayload
Deletes an excluded domain.
#
Input fieldsinput
(ExcludedDomainDeleteInput!
)
#
excludedDomainUpdateType: ExcludedDomainUpdatePayload
Updates an excluded domain.
#
Input fieldsinput
(ExcludedDomainUpdateInput!
)
#
folderCreateType: FolderCreatePayload
Creates an Inbox folder.
#
Input fieldsinput
(FolderCreateInput!
)
#
folderDeleteType: FolderDeletePayload
Deletes an Inbox folder.
#
Input fieldsinput
(FolderDeleteInput!
)
#
folderUpdateType: FolderUpdatePayload
Updates an Inbox folder.
#
Input fieldsinput
(FolderUpdateInput!
)
#
import2CreateType: Import2CreatePayload
No description
#
Input fieldsinput
(Import2CreateInput!
)
#
integrationDeleteType: IntegrationDeletePayload
Delete an integration.
Example:
#
Input fieldsinput
(IntegrationDeleteInput!
)
#
integrationDeleteByProviderType: IntegrationDeleteByProviderPayload
Delete an integrations by provider.
Example:
#
Input fieldsinput
(IntegrationDeleteByProviderInput!
)
#
integrationJiraServerUpsertType: IntegrationJiraServerCreatePayload
Update or create a Jira Server integration.
#
Input fieldsinput
(IntegrationJiraServerCreateInput!
)
#
integrationProviderSettingsUpdateType: IntegrationProviderSettingsUpdatePayload
Update settings for all integrations for a specific provider.
For example:
#
Input fieldsinput
(IntegrationProviderSettingsUpdateInput!
)
#
integrationSettingsUpdateType: IntegrationSettingsUpdatePayload
Update settings for an integration.
For example:
#
Input fieldsinput
(IntegrationSettingsUpdateInput!
)
#
kbArticleDeleteType: KbArticleDeletePayload
No description
#
Input fieldsinput
(KbArticleDeleteInput!
)
#
kbSlugAvailabilityType: KbSlugAvailabilityPayload
No description
#
Input fieldsinput
(KbSlugAvailabilityInput!
)
#
kbSubdomainAvailabilityType: KbSubdomainAvailabilityPayload
No description
#
Input fieldsinput
(KbSubdomainAvailabilityInput!
)
#
loginType: LoginPayload
No description
#
Input fieldsinput
(LoginInput!
)
#
mobileNotificationPreferencesUpsertType: MobileNotificationPreferencesUpsertPayload
No description
#
Input fields#
pushTokenClearNotificationCountType: PushTokenClearNotificationCountPayload
#
Input fieldsinput
(PushTokenClearNotificationCountInput!
)
#
pushTokenCreateType: PushTokenCreatePayload
No description
#
Input fieldsinput
(PushTokenCreateInput!
)
#
pushTokenDeleteType: PushTokenDeletePayload
#
Input fieldsinput
(PushTokenDeleteInput!
)
#
roomDeleteType: DeleteRoomPayload
Deletes a Live Chat room.
#
Input fieldsinput
(DeleteRoomInput!
)
#
rpcType: SyncRpcPayload
No description
#
Input fieldsinput
(SyncRpcInput!
)
#
ruleCreateType: RuleCreatePayload
Creates a Rule.
#
Input fieldsinput
(RuleCreateInput!
)
#
ruleDeleteType: RuleDeletePayload
Deletes a Rule.
#
Input fieldsinput
(RuleDeleteInput!
)
#
ruleUpdateType: RuleUpdatePayload
Updates a Rule.
#
Input fieldsinput
(RuleUpdateInput!
)
#
starredCannedReplyCreateType: StarredCannedReplyCreatePayload
No description
#
Input fieldsinput
(StarredCannedReplyCreateInput!
)
#
starredCannedReplyDeleteType: StarredCannedReplyDeletePayload
No description
#
Input fieldsinput
(StarredCannedReplyDeleteInput!
)
#
tagBatchDeleteType: TagBatchDeletePayload
Deletes an Inbox tag.
#
Input fieldsinput
(TagBatchDeleteInput!
)
#
tagCreateType: TagCreatePayload
Creates an Inbox tag.
To apply an existing tag to a conversation see conversationTag
.
#
Input fieldsinput
(TagCreateInput!
)
#
tagDeleteType: TagDeletePayload
Deletes an Inbox tag.
To remove an existing tag from a conversation see conversationUntag
.
#
Input fieldsinput
(TagDeleteInput!
)
#
tagMergeType: TagMergePayload
Merges one or more tags into a parent tag.
#
Input fieldsinput
(TagMergeInput!
)
#
tagUpdateType: TagUpdatePayload
Updates an Inbox tag.
To change tags applied to a conversation see the conversationTag
or
conversationUntag
mutations.
#
Input fieldsinput
(TagUpdateInput!
)
#
teamCreateType: teamsCreatePayload
No description
#
Input fieldsinput
(teamsCreateInput!
)
#
teamDestroyType: teamsDestroyPayload
No description
#
Input fieldsinput
(teamsDestroyInput!
)
#
teamUpdateType: teamsUpdatePayload
No description
#
Input fieldsinput
(teamsUpdateInput!
)
#
updatePresenceType: UpdatePresencePayload
Returns the provided list of Matrix room IDs with a flag indicating the ability of the current use to access each of them.
#
Input fieldsinput
(UpdatePresenceInput!
)
#
uploadPayloadGenerateType: UploadPayloadGeneratePayload
When uploading a new file to s3, you must include all of the payload fields in order, followed by a field, in your POST request.
#
Input fieldsinput
(UploadPayloadGenerateInput!
)
#
walletTransactionCreateType: WalletTransactionCreatePayload
No description
#
Input fieldsinput
(WalletTransactionCreateInput!
)
#
walletUpdateType: WalletUpdatePayload
No description
#
Input fieldsinput
(WalletUpdateInput!
)