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.

ContactAddLabelInput#

Autogenerated input type of ContactAddLabel

type ContactAddLabelInput {
labelIds: [ID!]!
contactId: ID!
clientMutationId: String
}

Fields#

NameDescription
labelIds ([ID!]!) The ID of the label to apply.
contactId (ID!) The ID of the contact to apply the label to.
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.

ContactRemoveLabelInput#

Autogenerated input type of ContactRemoveLabel

type ContactRemoveLabelInput {
labelIds: [ID!]!
contactId: ID!
clientMutationId: String
}

Fields#

NameDescription
labelIds ([ID!]!) The ID of the label to remove.
contactId (ID!) The ID of the contact to remove the label from.
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!]!
clientMutationId: String
}

Fields#

NameDescription
items ([SubjectWithCustomFieldsInput!]!) A batch of contacts or companies with the custom fields to create, update, or delete.
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.

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.

LabelCreateInput#

Autogenerated input type of LabelCreate

type LabelCreateInput {
name: String!
permittedAgentIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
name (String!) The label name.
permittedAgentIds ([ID!]) A list of IDs of agents that are allowed access.
clientMutationId (String) A unique identifier for the client performing the mutation.

LabelDeleteInput#

Autogenerated input type of LabelDelete

type LabelDeleteInput {
labelId: ID!
clientMutationId: String
}

Fields#

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

LabelOrder#

No description

type LabelOrder {
field: LabelOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (LabelOrderField) The field to order labels by.
direction (OrderDirection) The direction to sort labels in.

LabelUpdateInput#

Autogenerated input type of LabelUpdate

type LabelUpdateInput {
labelId: ID!
name: String!
permittedAgentIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
labelId (ID!) The ID of the label to update.
name (String!) The label name.
permittedAgentIds ([ID!]) A list of IDs of agents that are allowed access.
clientMutationId (String) A unique identifier for the client performing the mutation.

SegmentCreateInput#

Autogenerated input type of SegmentCreate

type SegmentCreateInput {
name: String!
description: String
permittedAgentIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
name (String!) The segment name.
description (String) A description of the segment.
permittedAgentIds ([ID!]) A list of IDs of agents that are allowed access.
clientMutationId (String) A unique identifier for the client performing the mutation.

SegmentDeleteInput#

Autogenerated input type of SegmentDelete

type SegmentDeleteInput {
segmentId: ID!
clientMutationId: String
}

Fields#

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

SegmentOrder#

No description

type SegmentOrder {
field: SegmentOrderField
direction: OrderDirection
}

Fields#

NameDescription
field (SegmentOrderField) The field to order segments by.
direction (OrderDirection) The direction to sort segments in.

SegmentUpdateInput#

Autogenerated input type of SegmentUpdate

type SegmentUpdateInput {
segmentId: ID!
name: String
description: String
permittedAgentIds: [ID!]
clientMutationId: String
}

Fields#

NameDescription
segmentId (ID!) The ID of the segment to update.
name (String) The segment name.
description (String) A description of the segment.
permittedAgentIds ([ID!]) A list of IDs of agents that are allowed access.
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.