Mutations

companyAddContacts#

Type: CompanyAddContactsPayload

Autogenerated return type of CompanyAddContacts

Adds contacts to a company.

For example:

mutation CompanyAddContacts($companyId: ID!, $contactIds: [ID!]!) {
companyAddContacts(input: { companyId: $companyId, contactIds: $contactIds }) {
company {
contacts {
nodes {
id
}
}
}
errors {
message
path
}
}
}
companyAddContacts(
input: CompanyAddContactsInput!
): CompanyAddContactsPayload

InputFields#

undefined#

NameDescription
input (CompanyAddContactsInput!) Parameters for CompanyAddContacts.

companyCreate#

Type: CompanyCreatePayload

Autogenerated return type of CompanyCreate

Creates a company.

For example:

mutation CompanyCreate(
$customFields: [CustomFieldInput!]
) {
companyCreate(
input: {
customFields: $customFields
}
) {
company {
id
}
errors {
message
path
}
}
}
companyCreate(
input: CompanyCreateInput!
): CompanyCreatePayload

InputFields#

undefined#

NameDescription
input (CompanyCreateInput!) Parameters for CompanyCreate.

companyDelete#

Type: CompanyDeletePayload

Autogenerated return type of CompanyDelete

Deletes a company.

For example:

mutation CompanyDelete($companyId: ID!) {
companyDelete(input: { companyId: $companyId }) {
deletedCompanyId
errors {
message
path
}
}
}
companyDelete(
input: CompanyDeleteInput!
): CompanyDeletePayload

InputFields#

undefined#

NameDescription
input (CompanyDeleteInput!) Parameters for CompanyDelete.

companyMerge#

Type: CompanyMergePayload

Autogenerated return type of CompanyMerge

Merges one company (the source) into another company (the target). The target company is preserved, and the source company is deleted.

The fields in keepFieldIds from the source company will be preserved in the merge, and will be merged into the destination company.

mutation CompanyMerge($companyId: ID!, $targetId: ID!) {
companyMerge(input: { companyId: $companyId, targetId: $targetId }) {
target {
id
}
errors {
message
path
}
}
}
companyMerge(
input: CompanyMergeInput!
): CompanyMergePayload

InputFields#

undefined#

NameDescription
input (CompanyMergeInput!) Parameters for CompanyMerge.

companyRemoveContacts#

Type: CompanyRemoveContactsPayload

Autogenerated return type of CompanyRemoveContacts

Remove contacts from a company.

E.g.:

mutation CompanyRemoveContacts($companyId: ID!, $contactIds: [ID!]!) {
companyRemoveContacts(input: { companyId: $companyId, contactIds: $contactIds }) {
company {
contacts {
nodes {
id
}
}
}
errors {
message
path
}
}
}
companyRemoveContacts(
input: CompanyRemoveContactsInput!
): CompanyRemoveContactsPayload

InputFields#

undefined#

NameDescription
input (CompanyRemoveContactsInput!) Parameters for CompanyRemoveContacts.

contactAddLabel#

Type: ContactAddLabelPayload

Autogenerated return type of ContactAddLabel

Applies a label to a contact.

mutation ContactAddLabel($labelId: [ID!]!, $contactId: ID!) {
contactAddLabel(input: { labelId: $labelId, contactId: $contactId }) {
errors {
message
path
}
}
}
contactAddLabel(
input: ContactAddLabelInput!
): ContactAddLabelPayload

InputFields#

undefined#

NameDescription
input (ContactAddLabelInput!) Parameters for ContactAddLabel.

contactCreate#

Type: ContactCreatePayload

Autogenerated return type of ContactCreate

Creates a contact.

For example:

mutation CompanyCreate(
$name: String!,
$domain: String!,
$customFields: [CustomFieldInput!]
) {
companyCreate(
input: {
name: $name,
domain: $domain,
customFields: $customFields
}
) {
company {
id
}
errors {
message
path
}
}
}
contactCreate(
input: ContactCreateInput!
): ContactCreatePayload

InputFields#

undefined#

NameDescription
input (ContactCreateInput!) Parameters for ContactCreate.

contactDelete#

Type: ContactDeletePayload

Autogenerated return type of ContactDelete

Deletes a contact permanently.

mutation ContactDelete($contactId: ID!) {
contactDelete(input: { contactId: $contactId }) {
deletedContactId
errors {
message
path
}
}
}
contactDelete(
input: ContactDeleteInput!
): ContactDeletePayload

InputFields#

undefined#

NameDescription
input (ContactDeleteInput!) Parameters for ContactDelete.

contactMerge#

Type: ContactMergePayload

Autogenerated return type of ContactMerge

Merges one contact (the source) into another contact (the target). The target contact is preserved, and the source contact is deleted.

The fields in keepFieldIds from the source contact will be preserved in the merge, and will be merged into the destination contact.

mutation ContactMerge(
$sourceId: ID!,
$targetId: ID!,
$keepFieldIds: [ID!]
) {
contactMerge(input: {
sourceId: $sourceId,
targetId: $targetId,
keepFieldIds: $keepFieldIds
}) {
target {
id
}
errors {
message
path
}
}
}
contactMerge(
input: ContactMergeInput!
): ContactMergePayload

InputFields#

undefined#

NameDescription
input (ContactMergeInput!) Parameters for ContactMerge.

contactRemoveLabel#

Type: ContactRemoveLabelPayload

Autogenerated return type of ContactRemoveLabel

Removes a label from a contact.

mutation ContactRemoveLabel($labelIds: [ID!]!, $contactId: ID!) {
contactRemoveLabel(input: { labelId: $labelIds, contactId: $contactId }) {
errors {
message
path
}
}
}
contactRemoveLabel(
input: ContactRemoveLabelInput!
): ContactRemoveLabelPayload

InputFields#

undefined#

NameDescription
input (ContactRemoveLabelInput!) Parameters for ContactRemoveLabel.

contactUpdate#

Type: ContactUpdatePayload

Autogenerated return type of ContactUpdate

Updates a contact.

mutation ContactUpdate(
$contactId: ID!,
$contactType: ContactType
) {
contactUpdate(input: {
contactId: $contactId,
contactType: $contactType
}) {
contact {
id
}
errors {
message
path
}
}
}
contactUpdate(
input: ContactUpdateInput!
): ContactUpdatePayload

InputFields#

undefined#

NameDescription
input (ContactUpdateInput!) Parameters for ContactUpdate.

customFieldCategoryCreate#

Type: CustomFieldCategoryCreatePayload

Autogenerated return type of CustomFieldCategoryCreate

Creates a custom field category.

mutation CustomFieldCategoryCreate(
$name: String!,
$type: CustomFieldCategoryType!,
$key: String!
) {
customFieldCategoryCreate(input: {
name: $name,
type: $type,
key: $key
}) {
errors {
message
path
}
category {
id
}
}
}
customFieldCategoryCreate(
input: CustomFieldCategoryCreateInput!
): CustomFieldCategoryCreatePayload

InputFields#

undefined#

NameDescription
input (CustomFieldCategoryCreateInput!) Parameters for CustomFieldCategoryCreate.

customFieldCategoryDelete#

Type: CustomFieldCategoryDeletePayload

Autogenerated return type of CustomFieldCategoryDelete

Deletes a custom field category.

mutation CustomFieldCategoryDelete(
$categoryId: ID!,
$newCategoryId: ID
) {
customFieldCategoryDelete(input: {
categoryId: $categoryId,
newCategoryId: $newCategoryId
}) {
deletedCategoryId
errors {
message
path
}
}
}
customFieldCategoryDelete(
input: CustomFieldCategoryDeleteInput!
): CustomFieldCategoryDeletePayload

InputFields#

undefined#

NameDescription
input (CustomFieldCategoryDeleteInput!) Parameters for CustomFieldCategoryDelete.

customFieldCategoryUpdate#

Type: CustomFieldCategoryUpdatePayload

Autogenerated return type of CustomFieldCategoryUpdate

Updates a custom field category.

mutation CustomFieldCategoryUpdate($categoryId: ID!, $name: String!) {
customFieldCategoryUpdate(input: { categoryId: $categoryId, name: $name }) {
errors {
message
path
}
category {
id
}
}
}
customFieldCategoryUpdate(
input: CustomFieldCategoryUpdateInput!
): CustomFieldCategoryUpdatePayload

InputFields#

undefined#

NameDescription
input (CustomFieldCategoryUpdateInput!) Parameters for CustomFieldCategoryUpdate.

customFieldCreate#

Type: CustomFieldCreatePayload

Autogenerated return type of CustomFieldCreate

Creates a custom field.

mutation CustomFieldCreate(
$categoryId: ID!,
$key: String!,
$name: String!,
$icon: CustomFieldIcon,
$description: String,
$type: CustomFieldType!,
$placeholder: String,
$isArray: Boolean!
$options: [CustomFieldOptionInput]
) {
customFieldCreate(input: {
categoryId: $categoryId,
key: $key,
name: $name,
icon: $icon,
description: $description,
type: $type,
placeholder: $placeholder,
isArray: $isArray
options: $options
}) {
customField {
id
}
errors {
message
path
}
}
}
customFieldCreate(
input: CustomFieldCreateInput!
): CustomFieldCreatePayload

InputFields#

undefined#

NameDescription
input (CustomFieldCreateInput!) Parameters for CustomFieldCreate.

customFieldDelete#

Type: CustomFieldDeletePayload

Autogenerated return type of CustomFieldDelete

Deletes a custom field.

mutation CustomFieldDelete(
$customFieldId: ID!,
$deleteMode: Boolean
) {
customFieldDelete(input: {
customFieldId: $customFieldId,
deleteMode: $deleteMode
}) {
errors {
message
path
}
}
}
customFieldDelete(
input: CustomFieldDeleteInput!
): CustomFieldDeletePayload

InputFields#

undefined#

NameDescription
input (CustomFieldDeleteInput!) Parameters for CustomFieldDelete.

customFieldOptionDelete#

Type: CustomFieldOptionDeletePayload

Autogenerated return type of CustomFieldOptionDelete

Deletes a custom field option.

mutation CustomFieldOptionDelete($customFieldOptionId: ID!) {
customFieldOptionDelete(input: { customFieldOptionId: $customFieldOptionId }) {
errors {
path
message
}
}
}
customFieldOptionDelete(
input: CustomFieldOptionDeleteInput!
): CustomFieldOptionDeletePayload

InputFields#

undefined#

NameDescription
input (CustomFieldOptionDeleteInput!) Parameters for CustomFieldOptionDelete.

customFieldRemove#

Type: CustomFieldRemovePayload

Autogenerated return type of CustomFieldRemove

Removes a custom field from a contact or company.

mutation CustomFieldRemove($customFieldId: ID!, $itemId: ID!) {
customFieldRemove(input: { customFieldId: $customFieldId, itemId: $itemId }) {
errors {
message
path
}
}
}
customFieldRemove(
input: CustomFieldRemoveInput!
): CustomFieldRemovePayload

InputFields#

undefined#

NameDescription
input (CustomFieldRemoveInput!) Parameters for CustomFieldRemove.

customFieldRestore#

Type: customFieldRestorePayload

Autogenerated return type of customFieldRestore

No description

customFieldRestore(
input: customFieldRestoreInput!
): customFieldRestorePayload

InputFields#

undefined#

NameDescription
input (customFieldRestoreInput!) Parameters for customFieldRestore.

customFieldUpdate#

Type: CustomFieldUpdatePayload

Autogenerated return type of CustomFieldUpdate

Updates a custom field.

mutation CustomFieldUpdate(
$customFieldId: ID!,
$categoryId: ID!,
$name: String,
$icon: CustomFieldIcon,
$options: [CustomFieldOptionInput]
) {
customFieldUpdate(input: {
customFieldId: $customFieldId,
categoryId: $categoryId,
name: $name,
icon: $icon,
options: $options
}) {
errors {
message
path
}
}
}
customFieldUpdate(
input: CustomFieldUpdateInput!
): CustomFieldUpdatePayload

InputFields#

undefined#

NameDescription
input (CustomFieldUpdateInput!) Parameters for CustomFieldUpdate.

customFieldValuesBulkUpdate#

Type: CustomFieldValuesBulkUpdatePayload

Autogenerated return type of CustomFieldValuesBulkUpdate

Updates multiple contact or company custom fields in one go.

This is important if, for example, you want to constantly synchronize your contacts with an external data source.

Changes will be proccessed asynchronously in the background.

mutation CustomFieldValuesBulkUpdate($items: [SubjectWithCustomFieldsInput!]!) {
customFieldBulkUpdate(input: { items: $items }) {
jid
}
}
customFieldValuesBulkUpdate(
input: CustomFieldValuesBulkUpdateInput!
): CustomFieldValuesBulkUpdatePayload

InputFields#

undefined#

NameDescription
input (CustomFieldValuesBulkUpdateInput!) Parameters for CustomFieldValuesBulkUpdate.

customFieldValuesUpdate#

Type: CustomFieldValuesUpdatePayload

Autogenerated return type of CustomFieldValuesUpdate

Creates, updates, or deletes custom field values for a contact or company.

mutation CustomFieldValuesUpdate(
$subjectId: ID!,
$customFieldList: [CustomFieldListInput]
) {
customFieldValuesUpdate(input: {
subjectId: $subjectId,
customFieldList: $values
}) {
subject {
id
}
}
}
customFieldValuesUpdate(
input: CustomFieldValuesUpdateInput!
): CustomFieldValuesUpdatePayload

InputFields#

undefined#

NameDescription
input (CustomFieldValuesUpdateInput!) Parameters for CustomFieldValuesUpdate.

excludedDomainCreate#

Type: ExcludedDomainCreatePayload

Autogenerated return type of ExcludedDomainCreate

Creates an excluded domain.

mutation(
$domain: String!
) {
excludedDomainCreate(
input: {
domain: $domain
}
) {
excludedDomain {
id
domain
}
errors {
message
path
}
}
}
excludedDomainCreate(
input: ExcludedDomainCreateInput!
): ExcludedDomainCreatePayload

InputFields#

undefined#

NameDescription
input (ExcludedDomainCreateInput!) Parameters for ExcludedDomainCreate.

excludedDomainDelete#

Type: ExcludedDomainDeletePayload

Autogenerated return type of ExcludedDomainDelete

Deletes an excluded domain.

mutation ExcludedDomainDelete($excludedDomainId: ID!) {
excludedDomainDelete(input: { excludedDomainId: $excludedDomainId }) {
deletedExcludedDomainId
errors {
message
path
}
}
}
excludedDomainDelete(
input: ExcludedDomainDeleteInput!
): ExcludedDomainDeletePayload

InputFields#

undefined#

NameDescription
input (ExcludedDomainDeleteInput!) Parameters for ExcludedDomainDelete.

excludedDomainUpdate#

Type: ExcludedDomainUpdatePayload

Autogenerated return type of ExcludedDomainUpdate

Updates an excluded domain.

mutation(
$excludedDomainId: ID!,
$domain: String!
) {
excludedDomainCreate(
input: {
excludedDomainId: $excludedDomainId,
domain: $domain
}
) {
excludedDomain {
id
domain
}
errors {
message
path
}
}
}
excludedDomainUpdate(
input: ExcludedDomainUpdateInput!
): ExcludedDomainUpdatePayload

InputFields#

undefined#

NameDescription
input (ExcludedDomainUpdateInput!) Parameters for ExcludedDomainUpdate.

labelCreate#

Type: LabelCreatePayload

Autogenerated return type of LabelCreate

Creates a CRM label.

To create a label for everyone:

mutation LabelCreate($name: String!) {
labelCreate(input: { name: $name }) {
label {
id
name
permittedAgentIds
}
errors {
message
path
}
}
}

To create a label that only certain agents can see and use:

mutation LabelCreate($name: String!, $permittedAgentIds: [ID!]) {
labelCreate(input: { name: $name, permittedAgentIds: $permittedAgentIds }) {
label {
id
name
permittedAgentIds
}
errors {
message
path
}
}
}
labelCreate(
input: LabelCreateInput!
): LabelCreatePayload

InputFields#

undefined#

NameDescription
input (LabelCreateInput!) Parameters for LabelCreate.

labelDelete#

Type: LabelDeletePayload

Autogenerated return type of LabelDelete

Deletes a CRM label. When a label is deleted it will be remove from all existing contacts.

mutation LabelDelete($labelId: ID!) {
labelDelete(input: { labelId: $labelId }) {
deletedLabelId
errors {
message
path
}
}
}
labelDelete(
input: LabelDeleteInput!
): LabelDeletePayload

InputFields#

undefined#

NameDescription
input (LabelDeleteInput!) Parameters for LabelDelete.

labelUpdate#

Type: LabelUpdatePayload

Autogenerated return type of LabelUpdate

Updates a CRM label.

mutation LabelUpdate($labelId: String!, $name: String!) {
labelUpdate(input: { labelId: $labelId, name: $name }) {
label {
name
}
errors {
message
path
}
}
}
labelUpdate(
input: LabelUpdateInput!
): LabelUpdatePayload

InputFields#

undefined#

NameDescription
input (LabelUpdateInput!) Parameters for LabelUpdate.

segmentCreate#

Type: SegmentCreatePayload

Autogenerated return type of SegmentCreate

Creates a segment.

mutation SegmentCreate($name: String!, $permittedAgentIds: [ID!]) {
segmentCreate(input: { name: $name, permittedAgentIds: $permittedAgentIds }) {
errors {
message
path
}
segment {
id
}
}
}
segmentCreate(
input: SegmentCreateInput!
): SegmentCreatePayload

InputFields#

undefined#

NameDescription
input (SegmentCreateInput!) Parameters for SegmentCreate.

segmentDelete#

Type: SegmentDeletePayload

Autogenerated return type of SegmentDelete

Deletes a segment.

mutation SegmentDelete($segmentId: ID!) {
segmentDelete(input: { segmentId: $segmentId }) {
errors {
message
path
}
}
}
segmentDelete(
input: SegmentDeleteInput!
): SegmentDeletePayload

InputFields#

undefined#

NameDescription
input (SegmentDeleteInput!) Parameters for SegmentDelete.

segmentUpdate#

Type: SegmentUpdatePayload

Autogenerated return type of SegmentUpdate

Updates a segment.

mutation SegmentUpdate($segmentId: ID!, $name: String!) {
segmentUpdate(input: { segmentId: $segmentId, name: $name }) {
segment {
id
name
}
errors {
message
path
}
}
}
segmentUpdate(
input: SegmentUpdateInput!
): SegmentUpdatePayload!

InputFields#

undefined#

NameDescription
input (SegmentUpdateInput!) Parameters for SegmentUpdate.