Inputs
#
CompanyAddContactsInputAutogenerated input type of CompanyAddContacts
#
FieldsName | Description |
---|---|
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. |
#
CompanyCreateInputAutogenerated input type of CompanyCreate
#
FieldsName | Description |
---|---|
customFields ([CustomFieldInput!] ) | The custom field values. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
CompanyDeleteInputAutogenerated input type of CompanyDelete
#
FieldsName | Description |
---|---|
companyId (ID! ) | The ID of the company to delete. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
CompanyFilterNo description
#
FieldsName | Description |
---|---|
search (String ) | Searches for companies that contain the provided string. |
#
CompanyMergeInputAutogenerated input type of CompanyMerge
#
FieldsName | Description |
---|---|
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. |
#
CompanyOrderNo description
#
FieldsName | Description |
---|---|
field (CompanyOrderField ) | The field to order companies by. |
direction (OrderDirection ) | The direction to sort companies in. |
#
CompanyRemoveContactsInputAutogenerated input type of CompanyRemoveContacts
#
FieldsName | Description |
---|---|
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. |
#
ContactCreateInputAutogenerated input type of ContactCreate
#
FieldsName | Description |
---|---|
contactType (ContactType! ) | The contact type. |
customFields ([CustomFieldInput!] ) | The custom field values. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
ContactCustomFieldsFilterNo description
#
FieldsName | Description |
---|---|
key (String! ) | The custom field key. |
values ([String!]! ) | The custom field values. |
#
ContactDeleteInputAutogenerated input type of ContactDelete
#
FieldsName | Description |
---|---|
contactId (ID! ) | The ID of the contact to delete. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
ContactFilterNo description
#
FieldsName | Description |
---|---|
search (String ) | Searches for contacts that contain the provided string. |
customFields ([ContactCustomFieldsFilter!] ) | Filters contacts by custom fields. |
#
ContactMergeInputAutogenerated input type of ContactMerge
#
FieldsName | Description |
---|---|
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. |
#
ContactOrderNo description
#
FieldsName | Description |
---|---|
field (ContactOrderField ) | The field to order contacts by. |
direction (OrderDirection ) | The direction to sort contacts in. |
#
ContactResyncInputAutogenerated input type of ContactResync
#
FieldsName | Description |
---|---|
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. |
#
ContactUpdateInputAutogenerated input type of ContactUpdate
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldCategoryCreateInputAutogenerated input type of CustomFieldCategoryCreate
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldCategoryDeleteInputAutogenerated input type of CustomFieldCategoryDelete
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldCategoryFilterNo description
#
FieldsName | Description |
---|---|
categoryType (CustomFieldCategoryType ) | Filters custom field categories by category type. |
#
CustomFieldCategoryUpdateInputAutogenerated input type of CustomFieldCategoryUpdate
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldCreateInputAutogenerated input type of CustomFieldCreate
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldDeleteInputAutogenerated input type of CustomFieldDelete
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldFilterNo description
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldInputNo description
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldListInputNo description
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldOptionDeleteInputAutogenerated input type of CustomFieldOptionDelete
#
FieldsName | Description |
---|---|
customFieldOptionId (ID! ) | The ID of the custom field option. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
CustomFieldOptionInputNo description
#
FieldsName | Description |
---|---|
label (String! ) | The label of the custom field option. |
value (String! ) | The value of the custom field option. |
#
CustomFieldRemoveInputAutogenerated input type of CustomFieldRemove
#
FieldsName | Description |
---|---|
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. |
#
customFieldRestoreInputAutogenerated input type of customFieldRestore
#
FieldsName | Description |
---|---|
customFieldId (ID! ) | The ID of the custom field to restore. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
CustomFieldUpdateInputAutogenerated input type of CustomFieldUpdate
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldValuesBulkUpdateInputAutogenerated input type of CustomFieldValuesBulkUpdate
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldValuesFilterNo description
#
FieldsName | Description |
---|---|
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. |
#
CustomFieldValuesUpdateInputAutogenerated input type of CustomFieldValuesUpdate
#
FieldsName | Description |
---|---|
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. |
#
EmailMarketingSubscriptionCreateInputAutogenerated input type of EmailMarketingSubscriptionCreate
#
FieldsName | Description |
---|---|
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. |
#
EmailMarketingSubscriptionDeleteInputAutogenerated input type of EmailMarketingSubscriptionDelete
#
FieldsName | Description |
---|---|
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. |
#
EventGroupsFilterInputNo description
#
FieldsName | Description |
---|---|
conversationId (ID! ) | Filters events by the ID of a conversation. |
changesetId (String ) | Filters events by changeset ID. |
#
EventsShopifyCreateInputAutogenerated input type of EventsShopifyCreate
#
FieldsName | Description |
---|---|
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. |
#
ExcludedDomainCreateInputAutogenerated input type of ExcludedDomainCreate
#
FieldsName | Description |
---|---|
domain (String! ) | The domain to exclude. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
ExcludedDomainDeleteInputAutogenerated input type of ExcludedDomainDelete
#
FieldsName | Description |
---|---|
excludedDomainId (ID! ) | The ID of the excluded domain to delete. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
ExcludedDomainUpdateInputAutogenerated input type of ExcludedDomainUpdate
#
FieldsName | Description |
---|---|
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. |
#
IntegrationDeleteByProviderInputAutogenerated input type of IntegrationDeleteByProvider
#
FieldsName | Description |
---|---|
provider (IntegrationProvider! ) | The provider to delete integrations for. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
IntegrationDeleteInputAutogenerated input type of IntegrationDelete
#
FieldsName | Description |
---|---|
integrationId (ID! ) | The ID of the integration to delete. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
IntegrationJiraServerCreateInputAutogenerated input type of IntegrationJiraServerCreate
#
FieldsName | Description |
---|---|
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. |
#
IntegrationProviderSettingsUpdateInputAutogenerated input type of IntegrationProviderSettingsUpdate
#
FieldsName | Description |
---|---|
provider (IntegrationProvider! ) | The provider to update settings for. |
settings (JSON! ) | The new settings. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
IntegrationSettingsUpdateInputAutogenerated input type of IntegrationSettingsUpdate
#
FieldsName | Description |
---|---|
integrationId (ID! ) | The integration to update settings for. |
settings (JSON! ) | The new settings. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
IntegrationsFilterNo description
#
FieldsName | Description |
---|---|
provider (IntegrationProvider ) | Filter by provider. |
#
LoginInputAutogenerated input type of Login
#
FieldsName | Description |
---|---|
subdomain (String! ) | A unique identifier for the client performing the mutation. |
#
MobileNotificationPreferencesUpsertInputAutogenerated input type of MobileNotificationPreferencesUpsert
#
FieldsName | Description |
---|---|
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. |
#
PushTokenClearNotificationCountInputAutogenerated input type of PushTokenClearNotificationCount
#
FieldsName | Description |
---|---|
pushTokenId (ID! ) | The ID of the push token to clear notifications for. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
PushTokenCreateInputAutogenerated input type of PushTokenCreate
#
FieldsName | Description |
---|---|
token (String! ) | The token. |
clientMutationId (String ) | A unique identifier for the client performing the mutation. |
#
SubjectWithCustomFieldsInputNo description
#
FieldsName | Description |
---|---|
subjectId (ID! ) | The ID of the contact or company to be updated. |
customFieldList ([CustomFieldListInput!]! ) | The custom fields to create, update, or remove. |
#
UploadPayloadGenerateInputAutogenerated input type of UploadPayloadGenerate