Inputs

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.

ContactCreateInput#

Autogenerated input type of ContactCreate

type ContactCreateInput {
contactType: ContactType!
customFields: [CustomFieldInput!]
clientMutationId: String
}

Fields#

NameDescription
contactType (ContactType!) The contact type.
customFields ([CustomFieldInput!]) The custom field values.
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
customFields: [ContactCustomFieldsFilter!]
}

Fields#

NameDescription
search (String) Searches for contacts that 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.

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!]
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.
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.

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.

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.

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.

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.

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.

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.

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.

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.