Inputs

AgentFilter#

No description

type AgentFilter {
state: AgentState
channelId: ID
}

Fields#

NameDescription
state (AgentState) Filters agents by state.
channelId (ID) Filters agents by who has access to the channel.

AgentNotificationPreferenceBulkDeleteInput#

Autogenerated input type of AgentNotificationPreferenceBulkDelete

type AgentNotificationPreferenceBulkDeleteInput {
ids: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
ids ([ID!]!) The IDs of the Agent Notification Preference Setting.
clientMutationId (String) A unique identifier for the client performing the mutation.

AgentNotificationPreferenceBulkUpsertInput#

Autogenerated input type of AgentNotificationPreferenceBulkUpsert

type AgentNotificationPreferenceBulkUpsertInput {
notificationPreferences: [AgentNotificationPreferenceInput!]!
clientMutationId: String
}

Fields#

NameDescription
notificationPreferences ([AgentNotificationPreferenceInput!]!) The Agent Notification Preferences.
clientMutationId (String) A unique identifier for the client performing the mutation.

AgentNotificationPreferenceInput#

No description

type AgentNotificationPreferenceInput {
id: ID
key: String!
namespace: AgentNotificationPreferenceNotificationNamespaceType
value: [AgentNotificationPreferenceNotificationType!]
}

AgentOrder#

No description

type AgentOrder {
field: AgentOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (AgentOrderField) The field to order agents by.
direction (OrderDirection) The direction to sort agents in.

AgentPreferenceDeleteInput#

Autogenerated input type of AgentPreferenceDelete

type AgentPreferenceDeleteInput {
key: String!
clientMutationId: String
}

Fields#

NameDescription
key (String!) The keys of the agent preferences.
clientMutationId (String) A unique identifier for the client performing the mutation.

AgentPreferenceUpsertInput#

Autogenerated input type of AgentPreferenceUpsert

type AgentPreferenceUpsertInput {
key: String!
namespace: String
value: JSON!
clientMutationId: String
}

Fields#

NameDescription
key (String!) The keys of the agent preferences.
namespace (String) The agent preferences namespace.
value (JSON!) The agent preferences value.
clientMutationId (String) A unique identifier for the client performing the mutation.

AgentPreferencesFilterInput#

No description

type AgentPreferencesFilterInput {
agentId: ID
namespace: String
keys: [String!]
}

Fields#

NameDescription
agentId (ID) Filter agent preferences by the ID of an agent.
namespace (String) Filters agent preferences by namespace.
keys ([String!]) Filters agent preferences by key.

AgentResetLoginAttemptsInput#

Autogenerated input type of AgentResetLoginAttempts

type AgentResetLoginAttemptsInput {
agentId: ID
clientMutationId: String
}

Fields#

NameDescription
agentId (ID) The agent to reset login attempts for.
clientMutationId (String) A unique identifier for the client performing the mutation.

AgentResetPasswordInput#

Autogenerated input type of AgentResetPassword

type AgentResetPasswordInput {
token: String!
recaptchaToken: String!
password: String!
passwordConfirm: String!
authCode: String
clientMutationId: String
}

Fields#

NameDescription
token (String!) The token to reset the password.
recaptchaToken (String!) The reCAPTCHA token.
password (String!) The new password.
passwordConfirm (String!) The new password confirmation.
authCode (String) The two factor authentication code.
clientMutationId (String) A unique identifier for the client performing the mutation.

AgentSendAdminEmailNotificationInput#

Autogenerated input type of AgentSendAdminEmailNotification

type AgentSendAdminEmailNotificationInput {
notificationType: AdminEmailNotification!
clientMutationId: String
}

Fields#

NameDescription
notificationType (AdminEmailNotification!) The type of email notification to send.
clientMutationId (String) A unique identifier for the client performing the mutation.

ArticleFilter#

No description

type ArticleFilter {
author: ID
category: ID
featured: Boolean
ids: [ID!]
keywords: String
knowledgeBase: ID
state: [PublishState!]
tag: String
}

Fields#

NameDescription
author (ID) Filters articles by the ID of an author.
category (ID) Filters articles by the ID of a category.
featured (Boolean) If true, filters by featured articles; if false, filters by articles that are not featured.
ids ([ID!]) Filters articles by IDs.
keywords (String) Searches for articles that match the keywords.
knowledgeBase (ID) Filters articles by the ID of a Knowledge Base.
state ([PublishState!]) Filters articles by status.
tag (String) Searches for articles with the specified tag names (comma separated.

ArticleOrder#

No description

type ArticleOrder {
field: ArticleOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (ArticleOrderField) The field to order articles by.
direction (OrderDirection) The direction to sort articles in.

AssignedFilter#

Filters conversations by their assigned agent or team, or those that explicitly are not assigned.

For example, to find a conversation assigned to a specific agent and any team:

filter: { assigned: { agent: "ag_1234567" }`

To find a conversation assigned to a specific agent and no team:

filter: { assigned: { agent: "ag_1234567", no_team: true }
type AssignedFilter {
agent: ID
noAgent: Boolean
team: ID
noTeam: Boolean
any: Boolean
}

Fields#

NameDescription
agent (ID) Filters conversations by the ID of the assigned agent.
noAgent (Boolean) Filters by conversations that have no agent assigned.
team (ID) Filters conversations by the ID of the assigned team.
noTeam (Boolean) Filters by conversations that have no team assigned.
any (Boolean) Filters by conversations that are assigned to any agent or team.

AssignmentInput#

No description

type AssignmentInput {
agentId: ID
teamId: ID
}

Fields#

NameDescription
agentId (ID) The ID of the agent to assign the conversation to.
teamId (ID) The ID of the team to assign the conversation to.

AsyncRpcInput#

Autogenerated input type of AsyncRpc

type AsyncRpcInput {
service: String!
method: String!
params: JSON
clientMutationId: String
}

Fields#

NameDescription
service (String!) The RPC service name.
method (String!) The name of the rpc to call.
params (JSON) JSON object of named function arguments.
clientMutationId (String) A unique identifier for the client performing the mutation.

AttachmentsFilterInput#

No description

type AttachmentsFilterInput {
conversationId: ID!
conversationType: AttachmentsConversationTypeEnum!
}

Fields#

NameDescription
conversationId (ID!) Filters attachments by the ID of a conversation.
conversationType (AttachmentsConversationTypeEnum!) Filters attachments by a resource - the current conversation or all conversations.

CancelDowngradeInput#

Autogenerated input type of CancelDowngrade

type CancelDowngradeInput {
clientMutationId: String
}

Fields#

NameDescription
clientMutationId (String) A unique identifier for the client performing the mutation.

CannedReplyFilter#

No description

type CannedReplyFilter {
ids: [ID!]
keywords: String
categoryIds: [ID!]
}

Fields#

NameDescription
ids ([ID!]) Filters canned replies by IDs.
keywords (String) Searches for canned replies that match the keywords.
categoryIds ([ID!]) Filters canned replies by categories.

CannedReplyOrder#

No description

type CannedReplyOrder {
field: CannedReplyOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (CannedReplyOrderField) The field to order canned replies by.
direction (OrderDirection) The direction to sort canned replies in.

CardSetupIntentCreateInput#

Autogenerated input type of CardSetupIntentCreate

type CardSetupIntentCreateInput {
clientMutationId: String
}

Fields#

NameDescription
clientMutationId (String) A unique identifier for the client performing the mutation.

CardSetupIntentSucceedInput#

Autogenerated input type of CardSetupIntentSucceed

type CardSetupIntentSucceedInput {
setupIntentId: ID!
clientMutationId: String
}

Fields#

NameDescription
setupIntentId (ID!) The stripe setup intent id.
clientMutationId (String) A unique identifier for the client performing the mutation.

CategoryOrder#

No description

type CategoryOrder {
field: CategoryOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (CategoryOrderField) The field to order canned reply categories by.
direction (OrderDirection) The direction to sort canned reply categories in.

ChannelFilter#

No description

type ChannelFilter {
state: ChannelState
scope: ChannelScope
}

Fields#

NameDescription
state (ChannelState) Filters channel by status.
scope (ChannelScope) Filters channels by scope.

ChannelOrder#

No description

type ChannelOrder {
field: ChannelOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (ChannelOrderField) The field to order channels by.
direction (OrderDirection) The direction to sort channels in.

CheckAccessByMatrixIdsInput#

Autogenerated input type of CheckAccessByMatrixIds

type CheckAccessByMatrixIdsInput {
matrixRoomIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
matrixRoomIds ([ID!]!) The IDs of the Matrix rooms that need to be checked.
clientMutationId (String) A unique identifier for the client performing the mutation.

ClickCreateInput#

Autogenerated input type of ClickCreate

type ClickCreateInput {
referralCode: String!
clientMutationId: String
}

Fields#

NameDescription
referralCode (String!) The referral code that belongs to affiliate.
clientMutationId (String) A unique identifier for the client performing the mutation.

CompanyAddContactsInput#

Autogenerated input type of CompanyAddContacts

type CompanyAddContactsInput {
companyId: ID!
contactIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
companyId (ID!) The ID of the company to add the contacts to.
contactIds ([ID!]!) The IDs of the contacts to add.
clientMutationId (String) A unique identifier for the client performing the mutation.

CompanyCreateInput#

Autogenerated input type of CompanyCreate

type CompanyCreateInput {
customFields: [CustomFieldInput!]
clientMutationId: String
}

Fields#

NameDescription
customFields ([CustomFieldInput!]) The custom field values.
clientMutationId (String) A unique identifier for the client performing the mutation.

CompanyDeleteInput#

Autogenerated input type of CompanyDelete

type CompanyDeleteInput {
companyId: ID!
clientMutationId: String
}

Fields#

NameDescription
companyId (ID!) The ID of the company to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

CompanyFilter#

No description

type CompanyFilter {
search: String
}

Fields#

NameDescription
search (String) Searches for companies that contain the provided string.

CompanyMergeInput#

Autogenerated input type of CompanyMerge

type CompanyMergeInput {
companyId: ID!
targetId: ID!
keepFieldIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
companyId (ID!) The ID of the source company.
targetId (ID!) The ID of the target company.
keepFieldIds ([ID!]) The IDs of the custom fields to keep from the source company (otherwise the target custom fields are used.
clientMutationId (String) A unique identifier for the client performing the mutation.

CompanyOrder#

No description

type CompanyOrder {
field: CompanyOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (CompanyOrderField) The field to order companies by.
direction (OrderDirection) The direction to sort companies in.

CompanyRemoveContactsInput#

Autogenerated input type of CompanyRemoveContacts

type CompanyRemoveContactsInput {
companyId: ID!
contactIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
companyId (ID!) The ID of the company to remove the the contacts from.
contactIds ([ID!]!) The IDs of the contacts to remove.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConditionOrder#

No description

type ConditionOrder {
field: ConditionOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (ConditionOrderField) The field to order conditions by.
direction (OrderDirection) The direction to sort conditions in.

ContactCreateInput#

Autogenerated input type of ContactCreate

type ContactCreateInput {
contactType: ContactType!
customFields: [CustomFieldInput!]
companyId: ID
skipCompanyCreation: Boolean
clientMutationId: String
}

Fields#

NameDescription
contactType (ContactType!) The contact type.
customFields ([CustomFieldInput!]) The custom field values.
companyId (ID) The company that contact belongs to.
skipCompanyCreation (Boolean) When no matching company is found, skip auto creation.
clientMutationId (String) A unique identifier for the client performing the mutation.

ContactCustomFieldsFilter#

No description

type ContactCustomFieldsFilter {
key: String!
values: [String!]!
}

Fields#

NameDescription
key (String!) The custom field key.
values ([String!]!) The custom field values.

ContactDeleteInput#

Autogenerated input type of ContactDelete

type ContactDeleteInput {
contactId: ID!
clientMutationId: String
}

Fields#

NameDescription
contactId (ID!) The ID of the contact to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

ContactFilter#

No description

type ContactFilter {
search: String
email: String
customFields: [ContactCustomFieldsFilter!]
}

Fields#

NameDescription
search (String) Searches for contacts that contain the provided string.
email (String) Searches for contacts whose email contain the provided string.
customFields ([ContactCustomFieldsFilter!]) Filters contacts by custom fields.

ContactMergeInput#

Autogenerated input type of ContactMerge

type ContactMergeInput {
sourceId: ID!
targetId: ID!
keepFieldIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
sourceId (ID!) The ID of the source contact.
targetId (ID!) The ID of the target contact.
keepFieldIds ([ID!]) The IDs of the custom fields to keep from the source contact (otherwise the target custom fields are used.
clientMutationId (String) A unique identifier for the client performing the mutation.

ContactOrder#

No description

type ContactOrder {
field: ContactOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (ContactOrderField) The field to order contacts by.
direction (OrderDirection) The direction to sort contacts in.

ContactResyncInput#

Autogenerated input type of ContactResync

type ContactResyncInput {
contactId: ID!
integrationId: ID!
clientMutationId: String
}

Fields#

NameDescription
contactId (ID!) The ID of the contact to update.
integrationId (ID!) The ID of the integration that you want to resync data for.
clientMutationId (String) A unique identifier for the client performing the mutation.

ContactUpdateInput#

Autogenerated input type of ContactUpdate

type ContactUpdateInput {
contactId: ID!
contactType: ContactType!
clientMutationId: String
}

Fields#

NameDescription
contactId (ID!) The ID of the contact to update.
contactType (ContactType!) The contact type.
clientMutationId (String) A unique identifier for the client performing the mutation.

conversationAddNoteInput#

Autogenerated input type of conversationAddNote

type conversationAddNoteInput {
snoozeUntil: DateTime
conversationId: ID!
body: String
draftId: String
attachments: [EmailAttachmentInput!]
state: ConversationState
skipNotifications: Boolean
authorId: ID
createdAt: DateTime
updatedAt: DateTime
authorReassign: Boolean
clientMutationId: String
}

Fields#

NameDescription
snoozeUntil (DateTime) The date and time until which the conversation is snoozed. If blank and conversation state is SNOOZED, it is snoozed indefinitely.
conversationId (ID!) The ID of the conversation.
body (String) The body of the note.
draftId (String) The ID of the draft used for this note. The draft will be deleted once the note is created.
attachments ([EmailAttachmentInput!]) Attachments for the note.
state (ConversationState) The new state to set for the conversation.
skipNotifications (Boolean) Whether to skip notifications for this note.
authorId (ID) The agent that creates the message.
createdAt (DateTime) The date and time that the note was created.
updatedAt (DateTime) The date and time that the note was updated.
authorReassign (Boolean) Whether to assign author of the note to the ticket. Defaults to false.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationAssignInput#

Autogenerated input type of ConversationAssign

type ConversationAssignInput {
conversationId: ID!
agentId: ID
teamId: ID
skipNotifications: Boolean
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to assign.
agentId (ID) The agent to assign the conversation to.
teamId (ID) The team to assign the conversation to.
skipNotifications (Boolean) Whether to skip notifications to agents.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationBulkDeleteInput#

Autogenerated input type of ConversationBulkDelete

type ConversationBulkDeleteInput {
conversationIds: [ID!]!
deleteMode: DeleteMode
clientMutationId: String
}

Fields#

NameDescription
conversationIds ([ID!]!) The ID of the conversation to delete.
deleteMode (DeleteMode) The mode with which to delete the conversations.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationChangeChannelInput#

Autogenerated input type of ConversationChangeChannel

type ConversationChangeChannelInput {
conversationId: ID!
channelId: ID!
skipNotifications: Boolean
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to move.
channelId (ID!) The ID of the destination channel.
skipNotifications (Boolean) Whether to skip notifications to agents.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationChangeContactInput#

Autogenerated input type of ConversationChangeContact

type ConversationChangeContactInput {
conversationId: ID!
contactId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The conversation ID.
contactId (ID!) The contact ID.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationCloseInput#

Autogenerated input type of ConversationClose

type ConversationCloseInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to close.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationCountFilter#

No description

type ConversationCountFilter {
states: [ConversationState!]
}

Fields#

NameDescription
states ([ConversationState!]) Filters by conversation state.

ConversationCreateEmailInput#

Autogenerated input type of ConversationCreateEmail

type ConversationCreateEmailInput {
snoozeUntil: DateTime
assigned: AssignmentInput
channelId: ID!
message: EmailMessageInput!
state: ConversationState
cannedReplyId: ID
tagIds: [ID!]
skipNotifications: Boolean
createdAt: DateTime
clientMutationId: String
}

Fields#

NameDescription
snoozeUntil (DateTime) The date and time until which the conversation is snoozed. If blank and conversation state is SNOOZED, it is snoozed indefinitely.
assigned (AssignmentInput) The initially assigned agent or team.
channelId (ID!) The ID of the channel the conversation will happen in.
message (EmailMessageInput!) The first email message of the conversation.
state (ConversationState) The initial state of the conversation.
cannedReplyId (ID) The ID of the used canned reply.
tagIds ([ID!]) The IDs of the tags.
skipNotifications (Boolean) Whether to skip notifications for the conversation.
createdAt (DateTime) The date and time that the ticket was created.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationDeleteInput#

Autogenerated input type of ConversationDelete

type ConversationDeleteInput {
conversationIds: [ID!]!
deleteMode: DeleteMode
clientMutationId: String
}

Fields#

NameDescription
conversationIds ([ID!]!) The ID of the conversations to delete.
deleteMode (DeleteMode) The mode with which to delete the conversations.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationFilter#

No description

type ConversationFilter {
assigned: AssignedFilter
channelId: ID
contactId: ID
deleted: Boolean
draftAuthor: ID
folderId: ID
keywords: String
mentionedAgent: ID
rating: RatingEnum
starred: Boolean
state: ConversationState
tag: ID
tagName: String
type: [ConversationType!]
}

Fields#

NameDescription
assigned (AssignedFilter) Filters conversations by the assigned agent or team.
channelId (ID) Filters conversations by the ID of a channel.
contactId (ID) Filters conversations by the ID of the contact that sent it.
deleted (Boolean) If true, filters by conversations that are trashed; if false, filters by conversations that are not trashed.
draftAuthor (ID) Filters conversations that have drafts by the specified author ID.
folderId (ID) Filters conversations by the ID of a folder.
keywords (String) Searches for conversations that match the keywords.
mentionedAgent (ID) Filters conversations that mention the specified agent ID.
rating (RatingEnum) Searches for conversations with a matching latest rating.
starred (Boolean) If true, filters by conversations that are starred; if false, filters by conversations that are unstarred.
state (ConversationState) Filters conversations by status.
tag (ID) Filters conversations by the ID of a tag.
tagName (String) Searches for conversations with the specified tag names.
type ([ConversationType!]) Filters conversations by type.

ConversationFollowInput#

Autogenerated input type of ConversationFollow

type ConversationFollowInput {
conversationId: ID!
followerIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to follow.
followerIds ([ID!]!) The IDs of the agents to add as followers.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationForwardInput#

Autogenerated input type of ConversationForward

type ConversationForwardInput {
snoozeUntil: DateTime
conversationId: ID!
body: String
to: Email!
cc: [Email!]
bcc: [Email!]
subject: String
attachments: [EmailAttachmentInput!]
cannedReplyId: ID
draftId: String
state: ConversationState
clientMutationId: String
}

Fields#

NameDescription
snoozeUntil (DateTime) The date and time until which the conversation is snoozed. If blank and conversation state is SNOOZED, it is snoozed indefinitely.
conversationId (ID!) The ID of the conversation to forward.
body (String) The body of the forward.
to (Email!) The message recipient.
cc ([Email!]) The recipients to cc.
bcc ([Email!]) The recipients to bcc.
subject (String) The subject of the message.
attachments ([EmailAttachmentInput!]) Attachments for the message.
cannedReplyId (ID) The ID of the used canned reply.
draftId (String) The ID of the draft used for this forward. The draft will be deleted once the forward is created.
state (ConversationState) The new state to set for the conversation.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationLogInput#

Autogenerated input type of ConversationLog

type ConversationLogInput {
contactId: ID
skipNotifications: Boolean
assigned: AssignmentInput
channelId: ID!
message: NoteMessageInput!
state: ConversationState
cannedReplyId: ID
createdAt: DateTime
authorId: ID
clientMutationId: String
}

Fields#

NameDescription
contactId (ID) The contact that ticket should be attached to.
skipNotifications (Boolean) Whether to skip notifications for the conversation.
assigned (AssignmentInput) The initially assigned agent or team.
channelId (ID!) The ID of the channel the conversation will happen in.
message (NoteMessageInput!) The note starting the conversation.
state (ConversationState) The initial state of the conversation.
cannedReplyId (ID) The ID of the used canned reply.
createdAt (DateTime) The date and time that the ticket was created.
authorId (ID) The creator of the note and conversation.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationMergeInput#

Autogenerated input type of ConversationMerge

type ConversationMergeInput {
sourceId: ID!
targetId: ID!
clientMutationId: String
}

Fields#

NameDescription
sourceId (ID!) The ID of the source conversation.
targetId (ID!) The ID of the target conversation.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationMoveMessageInput#

Autogenerated input type of ConversationMoveMessage

type ConversationMoveMessageInput {
messageId: ID!
clientMutationId: String
}

Fields#

NameDescription
messageId (ID!) The ID of the message to move.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationOpenInput#

Autogenerated input type of ConversationOpen

type ConversationOpenInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to open.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationOrder#

No description

type ConversationOrder {
field: ConversationOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (ConversationOrderField) The field to order conversations by.
direction (OrderDirection) The direction to sort conversations in.

ConversationReplyInput#

Autogenerated input type of ConversationReply

type ConversationReplyInput {
snoozeUntil: DateTime
conversationId: ID!
body: String
to: Email!
cc: [Email!]
bcc: [Email!]
subject: String
attachments: [EmailAttachmentInput!]
draftId: String
cannedReplyId: ID
state: ConversationState
skipNotifications: Boolean
createdAt: DateTime
updatedAt: DateTime
tagIdsToAdd: [ID!]
tagIdsToRemove: [ID!]
removeAllTags: Boolean
agentId: ID
authorId: ID
teamId: ID
contactId: ID
clientMutationId: String
}

Fields#

NameDescription
snoozeUntil (DateTime) The date and time until which the conversation is snoozed. If blank and conversation state is SNOOZED, it is snoozed indefinitely.
conversationId (ID!) The ID of the conversation to reply to.
body (String) The body of the reply.
to (Email!) The message recipient.
cc ([Email!]) The recipients to cc.
bcc ([Email!]) The recipients to bcc.
subject (String) The subject of the message.
attachments ([EmailAttachmentInput!]) Attachments for the message.
draftId (String) The ID of the draft used for this reply. The draft will be deleted once the reply is created.
cannedReplyId (ID) The ID of the used canned reply.
state (ConversationState) The new state to set for the conversation.
skipNotifications (Boolean) If notifications should be skipped.
createdAt (DateTime) The date and time that the message was created.
updatedAt (DateTime) The date and time that the message was updated.
tagIdsToAdd ([ID!]) The IDs of the tags to add.
tagIdsToRemove ([ID!]) The IDs of the tags to remove.
removeAllTags (Boolean) If all tags should be removed.
agentId (ID) The agent to assign the conversation to.
authorId (ID) The agent or contact that sends the message.
teamId (ID) The team to assign the conversation to.
contactId (ID) The contact that message should be attached to.
clientMutationId (String) A unique identifier for the client performing the mutation.

conversationRestoreInput#

Autogenerated input type of conversationRestore

type conversationRestoreInput {
conversationIds: [ID!]!
newState: ConversationRestoreState!
clientMutationId: String
}

Fields#

NameDescription
conversationIds ([ID!]!) The IDs of the conversations to restore.
newState (ConversationRestoreState!) The state to restore the conversation to.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationSnoozeInput#

Autogenerated input type of ConversationSnooze

type ConversationSnoozeInput {
conversationId: ID!
until: DateTime
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to snooze.
until (DateTime) The date and time until which the conversation is snoozed. If blank, it is snoozed indefinitely.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationSpamInput#

Autogenerated input type of ConversationSpam

type ConversationSpamInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to mark as spam.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationStarInput#

Autogenerated input type of ConversationStar

type ConversationStarInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to star.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationTagInput#

Autogenerated input type of ConversationTag

type ConversationTagInput {
conversationId: ID!
tagIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to tag.
tagIds ([ID!]!) The IDs of the tags to add.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationUnassignInput#

Autogenerated input type of ConversationUnassign

type ConversationUnassignInput {
conversationId: ID!
agent: Boolean
team: Boolean
skipNotifications: Boolean
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to snooze.
agent (Boolean) True to unassign the currently assigned agent; false or blank otherwise.
team (Boolean) True to unassign the currently assigned team; false or blank otherwise.
skipNotifications (Boolean) Whether to skip agent notifications.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationUnfollowInput#

Autogenerated input type of ConversationUnfollow

type ConversationUnfollowInput {
conversationId: ID!
followerIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to unfollow.
followerIds ([ID!]!) The IDs of the agents to remove as followers.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationUnreadInput#

Autogenerated input type of ConversationUnread

type ConversationUnreadInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to unread.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationUnstarInput#

Autogenerated input type of ConversationUnstar

type ConversationUnstarInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to unstar.
clientMutationId (String) A unique identifier for the client performing the mutation.

ConversationUntagInput#

Autogenerated input type of ConversationUntag

type ConversationUntagInput {
conversationId: ID!
tagIds: [ID!]!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to tag.
tagIds ([ID!]!) The IDs of the tags to add.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldCategoryCreateInput#

Autogenerated input type of CustomFieldCategoryCreate

type CustomFieldCategoryCreateInput {
type: CustomFieldCategoryType!
key: String!
name: String!
clientMutationId: String
}

Fields#

NameDescription
type (CustomFieldCategoryType!) The custom field category type.
key (String!) An inmutable identifier for the custom field category.
name (String!) The custom field category name.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldCategoryDeleteInput#

Autogenerated input type of CustomFieldCategoryDelete

type CustomFieldCategoryDeleteInput {
categoryId: ID!
newCategoryId: ID
clientMutationId: String
}

Fields#

NameDescription
categoryId (ID!) The ID of the custom field category to delete.
newCategoryId (ID) The ID of the custom field category to move the fields to. If blank then fields are soft deleted.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldCategoryFilter#

No description

type CustomFieldCategoryFilter {
categoryType: CustomFieldCategoryType
}

Fields#

NameDescription
categoryType (CustomFieldCategoryType) Filters custom field categories by category type.

CustomFieldCategoryUpdateInput#

Autogenerated input type of CustomFieldCategoryUpdate

type CustomFieldCategoryUpdateInput {
categoryId: ID!
name: String
clientMutationId: String
}

Fields#

NameDescription
categoryId (ID!) The ID of the custom field category to update.
name (String) The custom field category name.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldCreateInput#

Autogenerated input type of CustomFieldCreate

type CustomFieldCreateInput {
categoryId: ID!
key: String!
name: String!
icon: CustomFieldIcon
description: String
type: CustomFieldType!
placeholder: String
options: [CustomFieldOptionInput!]
isArray: Boolean!
clientMutationId: String
}

Fields#

NameDescription
categoryId (ID!) The ID of the custom field category.
key (String!) An immutable identifier for the custom field.
name (String!) The name of the custom field.
icon (CustomFieldIcon) The icon for the custom field.
description (String) A description of the custom field.
type (CustomFieldType!) The custom field type.
placeholder (String) The text to show in the input field when the custom field is empty.
options ([CustomFieldOptionInput!]) The available options for the custom field if the type is.
isArray (Boolean!) Whether or not to allow multiple values per contact/company for this field.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldDeleteInput#

Autogenerated input type of CustomFieldDelete

type CustomFieldDeleteInput {
customFieldId: ID!
deleteMode: DeleteMode
clientMutationId: String
}

Fields#

NameDescription
customFieldId (ID!) The ID of the custom field to delete.
deleteMode (DeleteMode) Soft-delete (move to trash) or hard-delete (permanent.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldFilter#

No description

type CustomFieldFilter {
categoryIds: [ID!]
deleted: Boolean
}

Fields#

NameDescription
categoryIds ([ID!]) Filters custom fields by category.
deleted (Boolean) If true, filters by custom fields that are trashed; if false, filters by custom fields that are not trashed.

CustomFieldInput#

No description

type CustomFieldInput {
customFieldIdOrKey: String!
value: JSON
position: Int
}

Fields#

NameDescription
customFieldIdOrKey (String!) The ID or key of the custom field.
value (JSON) The new value of the custom field.
position (Int) The order of the values for custom fields with array values.

CustomFieldListInput#

No description

type CustomFieldListInput {
customFieldIdOrKey: String!
value: JSON
position: Int
mode: customFieldValueUpdateMode
remove: Boolean
}

Fields#

NameDescription
customFieldIdOrKey (String!) The ID or key of the custom field.
value (JSON) The new value of the custom field.
position (Int) For array values this specifies the order.
mode (customFieldValueUpdateMode) For array values this specifies whether to append or replace.
remove (Boolean) True to remove the custom field from the contact or company; false or blank otherwise.

CustomFieldOptionDeleteInput#

Autogenerated input type of CustomFieldOptionDelete

type CustomFieldOptionDeleteInput {
customFieldOptionId: ID!
clientMutationId: String
}

Fields#

NameDescription
customFieldOptionId (ID!) The ID of the custom field option.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldOptionInput#

No description

type CustomFieldOptionInput {
label: String!
value: String!
}

Fields#

NameDescription
label (String!) The label of the custom field option.
value (String!) The value of the custom field option.

CustomFieldRemoveInput#

Autogenerated input type of CustomFieldRemove

type CustomFieldRemoveInput {
customFieldId: ID!
itemId: ID!
clientMutationId: String
}

Fields#

NameDescription
customFieldId (ID!) The ID of the custom field to remove.
itemId (ID!) The ID of the contact or company to remove the custom field from.
clientMutationId (String) A unique identifier for the client performing the mutation.

customFieldRestoreInput#

Autogenerated input type of customFieldRestore

type customFieldRestoreInput {
customFieldId: ID!
clientMutationId: String
}

Fields#

NameDescription
customFieldId (ID!) The ID of the custom field to restore.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldUpdateInput#

Autogenerated input type of CustomFieldUpdate

type CustomFieldUpdateInput {
customFieldId: ID!
categoryId: ID!
name: String!
icon: CustomFieldIcon
description: String
type: CustomFieldType!
placeholder: String
options: [CustomFieldOptionInput!]
handleType: String
clientMutationId: String
}

Fields#

NameDescription
customFieldId (ID!) The ID of the custom field to update.
categoryId (ID!) The ID of the custom field category.
name (String!) The name of the custom field.
icon (CustomFieldIcon) The icon for the custom field.
description (String) A description of the custom field.
type (CustomFieldType!) The custom field type.
placeholder (String) The text to show in the input field when the custom field is empty.
options ([CustomFieldOptionInput!]) The available options for the custom field if the type is.
handleType (String) The handle type.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldValuesBulkUpdateInput#

Autogenerated input type of CustomFieldValuesBulkUpdate

type CustomFieldValuesBulkUpdateInput {
items: [SubjectWithCustomFieldsInput!]!
sync: Boolean
clientMutationId: String
}

Fields#

NameDescription
items ([SubjectWithCustomFieldsInput!]!) A batch of contacts or companies with the custom fields to create, update, or delete.
sync (Boolean) Wait until request has completed before returning.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomFieldValuesFilter#

No description

type CustomFieldValuesFilter {
categoryIds: [ID!]
keys: [String!]
customFieldIds: [ID!]
deleted: Boolean
}

Fields#

NameDescription
categoryIds ([ID!]) Filters custom fields by category.
keys ([String!]) Filters custom field by key.
customFieldIds ([ID!]) Filters custom field by ID.
deleted (Boolean) If true, filters by custom fields that are trashed; if false, filters by custom fields that are not trashed.

CustomFieldValuesUpdateInput#

Autogenerated input type of CustomFieldValuesUpdate

type CustomFieldValuesUpdateInput {
customFieldList: [CustomFieldListInput!]
subjectId: ID!
clientMutationId: String
}

Fields#

NameDescription
customFieldList ([CustomFieldListInput!]) The custom fields to create, update, or remove.
subjectId (ID!) The ID of the contact or company to create, update, or remove the custom field on.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomerRatingSettingDeleteInput#

Autogenerated input type of CustomerRatingSettingDelete

type CustomerRatingSettingDeleteInput {
settingId: ID
clientMutationId: String
}

Fields#

NameDescription
settingId (ID) The ID of the customer rating setting.
clientMutationId (String) A unique identifier for the client performing the mutation.

CustomerRatingSettingUpsertInput#

Autogenerated input type of CustomerRatingSettingUpsert

type CustomerRatingSettingUpsertInput {
settingId: ID
locale: String!
mailboxIds: [String!]
name: String!
translations: JSON
clientMutationId: String
}

Fields#

NameDescription
settingId (ID) The ID of the customer rating setting.
locale (String!) The locale of the customer rating setting.
mailboxIds ([String!]) Selected mailboxes that rating should be scoped to.
name (String!) The name of the customer rating setting.
translations (JSON) The translations of the customer rating setting.
clientMutationId (String) A unique identifier for the client performing the mutation.

DeleteRoomInput#

Autogenerated input type of DeleteRoom

type DeleteRoomInput {
conversationId: ID!
clientMutationId: String
}

Fields#

NameDescription
conversationId (ID!) The ID of the conversation to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

DisconnectMutationInput#

Autogenerated input type of DisconnectMutation

type DisconnectMutationInput {
channelId: ID!
clientMutationId: String
}

Fields#

NameDescription
channelId (ID!) The ID of the channel to disconnect.
clientMutationId (String) A unique identifier for the client performing the mutation.

DraftDeleteInput#

Autogenerated input type of DraftDelete

type DraftDeleteInput {
draftId: String!
clientMutationId: String
}

Fields#

NameDescription
draftId (String!) The ID of the draft to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

DraftFilter#

No description

type DraftFilter {
id: ID
draftId: String
conversationId: ID
draftType: DraftType
}

Fields#

NameDescription
id (ID) Filters chat rooms by the ID of a draft.
draftId (String) The UUID used to identify the draft.
conversationId (ID) The conversation this draft belongs to.
draftType (DraftType) The type of the draft.

DraftOrder#

No description

type DraftOrder {
field: DraftOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (DraftOrderField) The field to order drafts by.
direction (OrderDirection) The direction to sort drafts by.

DraftSaveInput#

Autogenerated input type of DraftSave

type DraftSaveInput {
draftId: ID!
conversationId: ID!
contextId: ID
version: Int!
payload: String!
draftType: String!
synchronous: Boolean
clientMutationId: String
}

Fields#

NameDescription
draftId (ID!) The ID of the draft to save.
conversationId (ID!) The ID of the associated conversation.
contextId (ID) The ID of the context within the conversation.
version (Int!) The version of the draft.
payload (String!) The payload of the draft as a schemaless string.
draftType (String!) The type of the draft.
synchronous (Boolean) True if the change should be applied synchronously; false otherwise.
clientMutationId (String) A unique identifier for the client performing the mutation.

DraftUpsertInput#

Autogenerated input type of DraftUpsert

type DraftUpsertInput {
draftId: String!
conversationId: ID!
contextId: ID
version: Int!
payload: JSON!
metadata: JSON
draftType: DraftType!
clientMutationId: String
}

Fields#

NameDescription
draftId (String!) A UUID to identify the draft.
conversationId (ID!) The ID of the conversation.
contextId (ID) The ID of the context within the conversation.
version (Int!) The version of the draft.
payload (JSON!) The payload of the draft, which is a schemaless JSON object.
metadata (JSON) Metadata related to the draft.
draftType (DraftType!) The type of the draft.
clientMutationId (String) A unique identifier for the client performing the mutation.

EmailAttachmentInput#

No description

type EmailAttachmentInput {
key: String!
fileName: String!
fileSize: String!
contentType: String!
}

EmailMarketingSubscriptionCreateInput#

Autogenerated input type of EmailMarketingSubscriptionCreate

type EmailMarketingSubscriptionCreateInput {
integrationId: ID!
listId: String!
contactId: ID!
clientMutationId: String
}

Fields#

NameDescription
integrationId (ID!) The email marketing integration ID.
listId (String!) The email marketing integration list ID.
contactId (ID!) The ID of the contact to subscribe.
clientMutationId (String) A unique identifier for the client performing the mutation.

EmailMarketingSubscriptionDeleteInput#

Autogenerated input type of EmailMarketingSubscriptionDelete

type EmailMarketingSubscriptionDeleteInput {
integrationId: ID!
listId: String!
contactId: ID!
clientMutationId: String
}

Fields#

NameDescription
integrationId (ID!) The ID of the email marketing integration.
listId (String!) The ID of the email marketing list.
contactId (ID!) The ID of the contact to unsubscribe.
clientMutationId (String) A unique identifier for the client performing the mutation.

EmailMessageInput#

No description

type EmailMessageInput {
subject: String!
body: String!
createdAt: DateTime
updatedAt: DateTime
to: [EmailRecipientInput!]!
cc: [EmailRecipientInput!]
bcc: [EmailRecipientInput!]
attachments: [EmailAttachmentInput!]
authorId: ID
}

Fields#

NameDescription
subject (String!) The subject of the email.
body (String!) The body of the email.
createdAt (DateTime) The date and time that the message was created.
updatedAt (DateTime) The date and time that the message was updated.
to ([EmailRecipientInput!]!) The "To" recipients of the email.
cc ([EmailRecipientInput!]) The "Cc" recipients of the email.
bcc ([EmailRecipientInput!]) The "Bcc" recipients of the email.
attachments ([EmailAttachmentInput!]) Attachments for the message.
authorId (ID) The agent or contact that creates the message.

EmailRecipientInput#

No description

type EmailRecipientInput {
name: String!
email: String!
}

Fields#

NameDescription
name (String!) The name of the email recipient.
email (String!) The email address of the email recipient.

EventGroupsFilterInput#

No description

type EventGroupsFilterInput {
conversationId: ID!
changesetId: String
}

Fields#

NameDescription
conversationId (ID!) Filters events by the ID of a conversation.
changesetId (String) Filters events by changeset ID.

EventsFilterInput#

No description

type EventsFilterInput {
conversationId: ID!
eventGroupId: ID
changesetId: String
eventType: [EventType!]
}

Fields#

NameDescription
conversationId (ID!) Filters events by the ID of a conversation.
eventGroupId (ID) Filters events by the ID of an event group.
changesetId (String) Filters events by changeset ID.
eventType ([EventType!]) Filters events by type.

EventsShopifyCreateInput#

Autogenerated input type of EventsShopifyCreate

type EventsShopifyCreateInput {
agentId: ID
conversationId: ID!
changeType: ShopifyChangeType!
externalId: String!
meta: JSON
shopDomain: String!
clientMutationId: String
}

Fields#

NameDescription
agentId (ID) The ID of the agent who made the change. If null then the current agent.
conversationId (ID!) The ID of the conversation the event is linked to.
changeType (ShopifyChangeType!) The type of change.
externalId (String!) The ID of the item on Shopify.
meta (JSON) Additional event metadata.
shopDomain (String!) The shopify shop domain.
clientMutationId (String) A unique identifier for the client performing the mutation.

ExcludedDomainCreateInput#

Autogenerated input type of ExcludedDomainCreate

type ExcludedDomainCreateInput {
domain: String!
clientMutationId: String
}

Fields#

NameDescription
domain (String!) The domain to exclude.
clientMutationId (String) A unique identifier for the client performing the mutation.

ExcludedDomainDeleteInput#

Autogenerated input type of ExcludedDomainDelete

type ExcludedDomainDeleteInput {
excludedDomainId: ID!
clientMutationId: String
}

Fields#

NameDescription
excludedDomainId (ID!) The ID of the excluded domain to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

ExcludedDomainUpdateInput#

Autogenerated input type of ExcludedDomainUpdate

type ExcludedDomainUpdateInput {
excludedDomainId: ID!
domain: String!
clientMutationId: String
}

Fields#

NameDescription
excludedDomainId (ID!) The ID of the excluded domain to update.
domain (String!) The domain to exclude.
clientMutationId (String) A unique identifier for the client performing the mutation.

ExportFilter#

No description

type ExportFilter {
ids: [ID!]
}

Fields#

NameDescription
ids ([ID!]) Filters exports by specific ids.

ExportOrder#

No description

type ExportOrder {
field: ExportOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (ExportOrderField) The field to order exports by.
direction (OrderDirection) The direction to sort exports in.

FolderFilter#

No description

type FolderFilter {
ids: [ID!]
state: FolderState
channelIds: [ID!]
type: FolderType
scope: FolderScope
}

Fields#

NameDescription
ids ([ID!]) Filters folders by IDs.
state (FolderState) Filters folders by state.
channelIds ([ID!]) Filters folders by the ID of a channel.
type (FolderType) Filters folders by type.
scope (FolderScope) Filters folders by scope.

FolderOrder#

No description

type FolderOrder {
field: FolderOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (FolderOrderField) The field to order folders by.
direction (OrderDirection) The direction to sort folders in.

Import2CreateInput#

Autogenerated input type of Import2Create

type Import2CreateInput {
tool: String!
clientMutationId: String
}

Fields#

NameDescription
tool (String!) The name of the tool to source from.
clientMutationId (String) A unique identifier for the client performing the mutation.

ImportMutationInput#

Autogenerated input type of ImportMutation

type ImportMutationInput {
channelId: ID!
startAt: ISO8601DateTime!
endAt: ISO8601DateTime!
clientMutationId: String
}

Fields#

NameDescription
channelId (ID!) The ID of the channel to import messages for.
startAt (ISO8601DateTime!) The date and time to start importing messages from.
endAt (ISO8601DateTime!) The date and time to stop importing messages at.
clientMutationId (String) A unique identifier for the client performing the mutation.

IntegrationDeleteByProviderInput#

Autogenerated input type of IntegrationDeleteByProvider

type IntegrationDeleteByProviderInput {
provider: IntegrationProvider!
clientMutationId: String
}

Fields#

NameDescription
provider (IntegrationProvider!) The provider to delete integrations for.
clientMutationId (String) A unique identifier for the client performing the mutation.

IntegrationDeleteInput#

Autogenerated input type of IntegrationDelete

type IntegrationDeleteInput {
integrationId: ID!
clientMutationId: String
}

Fields#

NameDescription
integrationId (ID!) The ID of the integration to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

IntegrationJiraServerCreateInput#

Autogenerated input type of IntegrationJiraServerCreate

type IntegrationJiraServerCreateInput {
url: String!
username: String!
password: String
clientMutationId: String
}

Fields#

NameDescription
url (String!) The Jira Server URL.
username (String!) The username.
password (String) The password.
clientMutationId (String) A unique identifier for the client performing the mutation.

IntegrationProviderSettingsUpdateInput#

Autogenerated input type of IntegrationProviderSettingsUpdate

type IntegrationProviderSettingsUpdateInput {
provider: IntegrationProvider!
settings: JSON!
clientMutationId: String
}

Fields#

NameDescription
provider (IntegrationProvider!) The provider to update settings for.
settings (JSON!) The new settings.
clientMutationId (String) A unique identifier for the client performing the mutation.

IntegrationSettingsUpdateInput#

Autogenerated input type of IntegrationSettingsUpdate

type IntegrationSettingsUpdateInput {
integrationId: ID!
settings: JSON!
clientMutationId: String
}

Fields#

NameDescription
integrationId (ID!) The integration to update settings for.
settings (JSON!) The new settings.
clientMutationId (String) A unique identifier for the client performing the mutation.

IntegrationsFilter#

No description

type IntegrationsFilter {
provider: IntegrationProvider
}

Fields#

NameDescription
provider (IntegrationProvider) Filter by provider.

KbArticleDeleteInput#

Autogenerated input type of KbArticleDelete

type KbArticleDeleteInput {
articleId: ID!
clientMutationId: String
}

Fields#

NameDescription
articleId (ID!) The ID of the KB article.
clientMutationId (String) A unique identifier for the client performing the mutation.

KbSlugAvailabilityInput#

Autogenerated input type of KbSlugAvailability

type KbSlugAvailabilityInput {
value: ID!
knowledgeBaseId: ID!
clientMutationId: String
}

Fields#

NameDescription
value (ID!) The slug to check the availability for.
knowledgeBaseId (ID!) The ID of the KB.
clientMutationId (String) A unique identifier for the client performing the mutation.

KbSubdomainAvailabilityInput#

Autogenerated input type of KbSubdomainAvailability

type KbSubdomainAvailabilityInput {
value: ID!
clientMutationId: String
}

Fields#

NameDescription
value (ID!) The subdomain to check the availability for.
clientMutationId (String) A unique identifier for the client performing the mutation.

LoginInput#

Autogenerated input type of Login

type LoginInput {
subdomain: String!
email: String!
password: String!
csid: String
clientMutationId: String
}

Fields#

NameDescription
subdomain (String!) A unique identifier for the client performing the mutation.

MobileNotificationPreferencesUpsertInput#

Autogenerated input type of MobileNotificationPreferencesUpsert

type MobileNotificationPreferencesUpsertInput {
conversationCreated: Boolean
conversationAssignedToMe: Boolean
conversationAssignedToMyTeam: Boolean
conversationAssignedToOtherAgent: Boolean
agentRepliesToMyConversation: Boolean
agentRepliesToConversationAssignedToMyTeam: Boolean
agentRepliesToConversationAssignedToOtherAgent: Boolean
agentRepliesToUnassignedConversation: Boolean
agentMention: Boolean
customerRepliesToMyConversation: Boolean
customerRepliesToConversationAssignedToMyTeam: Boolean
customerRatesConversationAssignedToMe: Boolean
customerRatesConversationAssignedToMyTeam: Boolean
customerRatesConversationAssignedToOtherAgent: Boolean
clientMutationId: String
}

Fields#

NameDescription
conversationCreated (Boolean) If true then send a notification when a conversation is created.
conversationAssignedToMe (Boolean) If true then send a notification when a conversation is assigned to me.
conversationAssignedToMyTeam (Boolean) If true then send a notification when a conversation is assigned to my team.
conversationAssignedToOtherAgent (Boolean) If true then send a notification when a conversation is assigned to any other agent.
agentRepliesToMyConversation (Boolean) If true then send a notification when an agent replies to my conversation.
agentRepliesToConversationAssignedToMyTeam (Boolean) If true then send a notification when an agent replies to a conversation assigned to my team.
agentRepliesToConversationAssignedToOtherAgent (Boolean) If true then send a notification when an agent replies to a conversation assigned to another agent.
agentRepliesToUnassignedConversation (Boolean) If true then send a notification when an agent replies to an unassigned conversation.
agentMention (Boolean) If true then send a notification when an agent mentions me.
customerRepliesToMyConversation (Boolean) If true then send a notification when a customer replies to my conversation.
customerRepliesToConversationAssignedToMyTeam (Boolean) If true then send a notification when a customer replies to a conversation assigned to my team.
customerRatesConversationAssignedToMe (Boolean) If true then send a notification when a customer rates a conversation assigned to me.
customerRatesConversationAssignedToMyTeam (Boolean) If true then send a notification when a customer rates a conversation assigned to my team.
customerRatesConversationAssignedToOtherAgent (Boolean) If true then send a notification when a customer rates a conversation assigned to another agent.
clientMutationId (String) A unique identifier for the client performing the mutation.

NoteMessageInput#

No description

type NoteMessageInput {
subject: String!
body: String!
to: EmailRecipientInput
phone: String
}

Fields#

NameDescription
subject (String!) The subject of the email.
body (String!) The body of the email.
to (EmailRecipientInput) The contact email address.
phone (String) The contact phone number.

PushTokenClearNotificationCountInput#

Autogenerated input type of PushTokenClearNotificationCount

type PushTokenClearNotificationCountInput {
pushTokenId: ID!
clientMutationId: String
}

Fields#

NameDescription
pushTokenId (ID!) The ID of the push token to clear notifications for.
clientMutationId (String) A unique identifier for the client performing the mutation.

PushTokenCreateInput#

Autogenerated input type of PushTokenCreate

type PushTokenCreateInput {
token: String!
clientMutationId: String
}

Fields#

NameDescription
token (String!) The token.
clientMutationId (String) A unique identifier for the client performing the mutation.

PushTokenDeleteInput#

Autogenerated input type of PushTokenDelete

type PushTokenDeleteInput {
pushTokenId: ID!
clientMutationId: String
}

Fields#

NameDescription
pushTokenId (ID!) The ID of the push token to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

RoomFilter#

No description

type RoomFilter {
channelId: ID
folderId: ID
contactId: ID
channelType: RoomChannelTypeEnum
}

Fields#

NameDescription
channelId (ID) Filters chat rooms by the ID of a channel.
folderId (ID) Filters chat rooms by the ID of a folder.
contactId (ID) The ID of contact to filter the chat rooms by.
channelType (RoomChannelTypeEnum) The channel type that the request needs to be filtered by.

RoomOrder#

No description

type RoomOrder {
field: RoomOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (RoomOrderField) The field to order chat rooms by.
direction (OrderDirection) The direction to sort chat rooms in.

RuleFilter#

No description

type RuleFilter {
state: RuleState
}

Fields#

NameDescription
state (RuleState) Filters rules by state.

RuleOrder#

No description

type RuleOrder {
field: RuleOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (RuleOrderField) The field to order rules by.
direction (OrderDirection) The direction to sort rules in.

StarredCannedReplyCreateInput#

Autogenerated input type of StarredCannedReplyCreate

type StarredCannedReplyCreateInput {
cannedReplyId: ID!
clientMutationId: String
}

Fields#

NameDescription
cannedReplyId (ID!) The ID of the canned reply.
clientMutationId (String) A unique identifier for the client performing the mutation.

StarredCannedReplyDeleteInput#

Autogenerated input type of StarredCannedReplyDelete

type StarredCannedReplyDeleteInput {
cannedReplyId: ID!
clientMutationId: String
}

Fields#

NameDescription
cannedReplyId (ID!) The ID of the canned reply.
clientMutationId (String) A unique identifier for the client performing the mutation.

SubjectWithCustomFieldsInput#

No description

type SubjectWithCustomFieldsInput {
subjectId: ID!
customFieldList: [CustomFieldListInput!]!
}

Fields#

NameDescription
subjectId (ID!) The ID of the contact or company to be updated.
customFieldList ([CustomFieldListInput!]!) The custom fields to create, update, or remove.

SuggestionFilterInput#

No description

type SuggestionFilterInput {
conversationId: ID!
}

Fields#

NameDescription
conversationId (ID!) Filters conversation suggestions by the ID of a conversation.

SuggestionUpsertInput#

Autogenerated input type of SuggestionUpsert

type SuggestionUpsertInput {
suggestionType: AiConversationSuggestionType!
conversationId: ID!
suggestionId: ID
clientMutationId: String
}

Fields#

NameDescription
suggestionType (AiConversationSuggestionType!) The type of the suggestion to create or update.
conversationId (ID!) The ID of the conversation.
suggestionId (ID) The ID of the suggestion to update.
clientMutationId (String) A unique identifier for the client performing the mutation.

SyncRpcInput#

Autogenerated input type of SyncRpc

type SyncRpcInput {
service: String!
method: String!
params: JSON
clientMutationId: String
}

Fields#

NameDescription
service (String!) The RPC service name.
method (String!) The name of the rpc to call.
params (JSON) JSON object of named function arguments.
clientMutationId (String) A unique identifier for the client performing the mutation.

TagBatchDeleteInput#

Autogenerated input type of TagBatchDelete

type TagBatchDeleteInput {
filter: TagFilter
tagIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
filter (TagFilter) The fields by which to filter the results.
tagIds ([ID!]) The ID of the tags to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

TagCreateInput#

Autogenerated input type of TagCreate

type TagCreateInput {
color: String
name: String!
clientMutationId: String
}

Fields#

NameDescription
color (String) The color of the tag.
name (String!) The name of the tag.
clientMutationId (String) A unique identifier for the client performing the mutation.

TagDeleteInput#

Autogenerated input type of TagDelete

type TagDeleteInput {
tagId: ID!
clientMutationId: String
}

Fields#

NameDescription
tagId (ID!) The ID of the tag to delete.
clientMutationId (String) A unique identifier for the client performing the mutation.

TagFilter#

No description

type TagFilter {
ids: [ID!]
names: [String!]
search: String
conversationStates: [ConversationState!]
state: TagState
channelId: ID
}

Fields#

NameDescription
ids ([ID!]) Filters tags by IDs.
names ([String!]) Filter tags by exact names.
search (String) Searches for tags that contain the provided string.
conversationStates ([ConversationState!]) Filters tags by conversation state.
state (TagState) Filters tags by state.
channelId (ID) Filters tags by the channel they have been used in.

TagMergeInput#

Autogenerated input type of TagMerge

type TagMergeInput {
parentTagId: ID!
filter: TagFilter
tagIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
parentTagId (ID!) The ID of the parent tag that the other tags will be merged into.
filter (TagFilter) The fields by which to filter the child tag results.
tagIds ([ID!]) The ID of the tags to merge into the parent tag.
clientMutationId (String) A unique identifier for the client performing the mutation.

TagOrder#

No description

type TagOrder {
field: TagOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (TagOrderField) The field to order tags by.
direction (OrderDirection) The direction to sort tags in.

TagUpdateInput#

Autogenerated input type of TagUpdate

type TagUpdateInput {
color: String
tagId: ID!
name: String
clientMutationId: String
}

Fields#

NameDescription
color (String) The color of the tag.
tagId (ID!) The ID of the tag to update.
name (String) The name of the tag.
clientMutationId (String) A unique identifier for the client performing the mutation.

TeamFilter#

No description

type TeamFilter {
channelId: ID
}

Fields#

NameDescription
channelId (ID) Filters teams by which ones have access to the channel.

TeamOrder#

No description

type TeamOrder {
field: TeamOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (TeamOrderField) The field to order teams by.
direction (OrderDirection) The direction to sort teams in.

teamsCreateInput#

Autogenerated input type of teamsCreate

type teamsCreateInput {
name: String!
description: String
agentIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
name (String!) The name of the team.
description (String) The description of the team.
agentIds ([ID!]) Agents you want assign to assign. GID format: ag_XXX.
clientMutationId (String) A unique identifier for the client performing the mutation.

teamsDestroyInput#

Autogenerated input type of teamsDestroy

type teamsDestroyInput {
teamId: ID!
clientMutationId: String
}

Fields#

NameDescription
teamId (ID!) The id of the team.
clientMutationId (String) A unique identifier for the client performing the mutation.

teamsUpdateInput#

Autogenerated input type of teamsUpdate

type teamsUpdateInput {
teamId: ID!
name: String
description: String
agentIds: [String!]
clientMutationId: String
}

Fields#

NameDescription
teamId (ID!) The id of the team.
name (String) The name of the team.
description (String) The description of the team.
agentIds ([String!]) Agents you want assign to assign. GID format: ag_XXX.
clientMutationId (String) A unique identifier for the client performing the mutation.

UpdatePresenceInput#

Autogenerated input type of UpdatePresence

type UpdatePresenceInput {
presenceStatus: PresenceStatusType!
clientMutationId: String
}

Fields#

NameDescription
presenceStatus (PresenceStatusType!) The presence that should be applied to the current user.
clientMutationId (String) A unique identifier for the client performing the mutation.

UploadPayloadGenerateInput#

Autogenerated input type of UploadPayloadGenerate

type UploadPayloadGenerateInput {
fileName: String!
clientMutationId: String
}

Fields#

NameDescription
fileName (String!) The name of the file to upload.
clientMutationId (String) A unique identifier for the client performing the mutation.

WalletOptionsInput#

No description

type WalletOptionsInput {
userOnly: Boolean
}

Fields#

NameDescription
userOnly (Boolean) Filter wallets by user only.

WalletUpdateInput#

Autogenerated input type of WalletUpdate

type WalletUpdateInput {
autorenew: Boolean
autorenewAmount: Int
autorenewThreshold: Int
autorenewUses: Int
walletId: ID!
clientMutationId: String
}

Fields#

NameDescription
autorenew (Boolean) The autorenew status of the wallet.
autorenewAmount (Int) The autorenew amount of the wallet.
autorenewThreshold (Int) The autorenew threshold of the wallet.
autorenewUses (Int) The autorenew uses of the wallet.
walletId (ID!) The ID of the wallet to update.
clientMutationId (String) A unique identifier for the client performing the mutation.

WidgetFilter#

No description

type WidgetFilter {
channelType: WidgetChannelType
}

Fields#

NameDescription
channelType (WidgetChannelType) Filter by channel type.

On this page