Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriescontact

entities.contact

Read contact records with the contact repository, and change them with the contact mutations. Same records as the REST Contacts entity.

Queries

Fields of entities { contact { … } }.

Each operation opens an example built from the schema and checked against it on every build. Replace the placeholders, such as <contact id>, with values from your space.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
ContactEntity
Example
Example: getById
query ContactGetById {
  entities {
    contact {
      getById(entityId: "<contact id>") {
        id
        formattedName
        title
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetById { entities { contact { getById(entityId: \"<contact id>\") { id formattedName title modified } } } }"}'
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[ContactEntity!]!
Example
Example: getByIds
query ContactGetByIds {
  entities {
    contact {
      getByIds(entityIds: ["<contact id>"]) {
        id
        formattedName
        title
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetByIds { entities { contact { getByIds(entityIds: [\"<contact id>\"]) { id formattedName title modified } } } }"}'
QUERYgetAll(limit: Int, offset: Int, filter: ContactFilterInput, orderBy: [ContactOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[ContactEntity!]!
Example
Example: getAll
query ContactGetAll {
  entities {
    contact {
      getAll(limit: 10) {
        id
        formattedName
        title
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetAll { entities { contact { getAll(limit: 10) { id formattedName title modified } } } }"}'
QUERYgetByCriteria(filter: ContactFilterInput, orderBy: [ContactOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
ContactEntityConnection
Example
Example: getByCriteria
query ContactGetByCriteria {
  entities {
    contact {
      getByCriteria(first: 10) {
        totalCount
        edges {
          node {
            id
            formattedName
            title
            modified
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetByCriteria { entities { contact { getByCriteria(first: 10) { totalCount edges { node { id formattedName title modified } } pageInfo { hasNextPage endCursor } } } } }"}'
QUERYgetChangedFieldsSinceRevision(id: UUID!, revision: Int!)
Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
[UUID!]!
Example
Example: getChangedFieldsSinceRevision
query ContactGetChangedFieldsSinceRevision {
  entities {
    contact {
      getChangedFieldsSinceRevision(id: "<contact id>", revision: 10)
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetChangedFieldsSinceRevision { entities { contact { getChangedFieldsSinceRevision(id: \"<contact id>\", revision: 10) } } }"}'
QUERYgetBySession(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int)
Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.
ContactEntityConnection
Example
Example: getBySession
query ContactGetBySession {
  entities {
    contact {
      getBySession(
        includedIds: ["<contact id>"]
        excludedIds: ["<contact id>"]
        sessionId: "<session id>"
        first: 10
      ) {
        totalCount
        edges {
          node {
            id
            formattedName
            title
            modified
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetBySession { entities { contact { getBySession( includedIds: [\"<contact id>\"] excludedIds: [\"<contact id>\"] sessionId: \"<session id>\" first: 10 ) { totalCount edges { node { id formattedName title modified } } pageInfo { hasNextPage endCursor } } } } }"}'
QUERYgetByIdFormatted(id: UUID!, fieldIds: [UUID!])
Returns the values of a record's fields formatted for display, keyed by field id.
JSONString
Example
Example: getByIdFormatted
query ContactGetByIdFormatted {
  entities {
    contact {
      getByIdFormatted(id: "<contact id>")
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetByIdFormatted { entities { contact { getByIdFormatted(id: \"<contact id>\") } } }"}'
QUERYgetRelatedToAccount(limit: Int, offset: Int, filter: ContactFilterInput, orderBy: [ContactOrderByInput!], accountId: UUID, filterByName: String)
Returns the contacts linked to the given account, optionally narrowed by name.
[ContactEntity!]!
Example
Example: getRelatedToAccount
query ContactGetRelatedToAccount {
  entities {
    contact {
      getRelatedToAccount(limit: 10) {
        id
        formattedName
        title
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactGetRelatedToAccount { entities { contact { getRelatedToAccount(limit: 10) { id formattedName title modified } } } }"}'
QUERYautoPrefill(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID)
Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create.
ContactEntity!
Example
Example: autoPrefill
query ContactAutoPrefill {
  entities {
    contact {
      autoPrefill(mappingId: "<mapping id>", entityId: "<contact id>") {
        id
        formattedName
        title
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactAutoPrefill { entities { contact { autoPrefill(mappingId: \"<mapping id>\", entityId: \"<contact id>\") { id formattedName title modified } } } }"}'
QUERYaiAutoPrefill(actionId: String!)
Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in.
ContactAutoPrefill!
Example
Example: aiAutoPrefill
query ContactAiAutoPrefill {
  entities {
    contact {
      aiAutoPrefill(actionId: "<action id>") {
        entity {
          id
          formattedName
          title
          modified
        }
        fieldIds
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query ContactAiAutoPrefill { entities { contact { aiAutoPrefill(actionId: \"<action id>\") { entity { id formattedName title modified } fieldIds } } } }"}'

Mutations

KindMutationDoesReturns
MUTATIONchangeOwnershipContact(input: ChangeOwnershipContactInput!)Change owner GraphQL onlyChangeOwnershipContactPayload
Example
Example: changeOwnershipContact
mutation ChangeOwnershipContact {
  changeOwnershipContact(
    input: {ownerId: "<owner id>", unitId: "<unit id>", keepOwnerAsEditor: false, transferLinkedRecords: false, id: "<contact id>"}
  ) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ChangeOwnershipContact { changeOwnershipContact( input: {ownerId: \"<owner id>\", unitId: \"<unit id>\", keepOwnerAsEditor: false, transferLinkedRecords: false, id: \"<contact id>\"} ) { result { id formattedName title modified } } }"}'
MUTATIONmanageSharingContact(input: ManageSharingContactInput!)Change who it is shared with GraphQL onlyManageSharingContactPayload
Example
Example: manageSharingContact
mutation ManageSharingContact {
  manageSharingContact(input: {shareMode: Standard, id: "<contact id>"}) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ManageSharingContact { manageSharingContact(input: {shareMode: Standard, id: \"<contact id>\"}) { result { id formattedName title modified } } }"}'
MUTATIONrestoreContact(input: RestoreContactInput!)Restore a deleted recordRestoreContactPayload
Example
Example: restoreContact
mutation RestoreContact {
  restoreContact(input: {id: "<contact id>"}) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation RestoreContact { restoreContact(input: {id: \"<contact id>\"}) { result { id formattedName title modified } } }"}'
MUTATIONcopyContact(input: CopyContactInput!)Copy a record GraphQL onlyCopyContactPayload
Example
Example: copyContact
mutation CopyContact {
  copyContact(input: {id: "<contact id>"}) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation CopyContact { copyContact(input: {id: \"<contact id>\"}) { result { id formattedName title modified } } }"}'
MUTATIONmergeContact(input: MergeContactInput!)Merge duplicatesMergeContactPayload
Example
Example: mergeContact
mutation MergeContact {
  mergeContact(input: {master: {id: "<contact id>"}, slaveId: "<slave id>"}) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation MergeContact { mergeContact(input: {master: {id: \"<contact id>\"}, slaveId: \"<slave id>\"}) { result { id formattedName title modified } } }"}'
MUTATIONarchiveContact(input: ArchiveContactInput!)Archive GraphQL onlyArchiveContactPayload
Example
Example: archiveContact
mutation ArchiveContact {
  archiveContact(
    input: {entity: {id: "<contact id>"}, archiveAllRelatedLeads: false, archiveAllRelatedOpportunities: false, archiveAllRelatedQuotes: false, completeAllRelatedTasks: false}
  ) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ArchiveContact { archiveContact( input: {entity: {id: \"<contact id>\"}, archiveAllRelatedLeads: false, archiveAllRelatedOpportunities: false, archiveAllRelatedQuotes: false, completeAllRelatedTasks: false} ) { result { id formattedName title modified } } }"}'
MUTATIONreactivateContact(input: ReactivateContactInput!)Undo archive GraphQL onlyReactivateContactPayload
Example
Example: reactivateContact
mutation ReactivateContact {
  reactivateContact(input: {id: "<contact id>"}) {
    result {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ReactivateContact { reactivateContact(input: {id: \"<contact id>\"}) { result { id formattedName title modified } } }"}'
MUTATIONcreateContact(input: CreateContactInput!, validationLevel: [ValidationLevel!])Create one recordCreateContactPayload
Example
Example: createContact
mutation CreateContact {
  createContact(input: {ownerId: "<owner id>"}) {
    contact {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation CreateContact { createContact(input: {ownerId: \"<owner id>\"}) { contact { id formattedName title modified } } }"}'
MUTATIONupdateContact(input: UpdateContactInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateContactPayload
Example
Example: updateContact
mutation UpdateContact {
  updateContact(input: {id: "<contact id>"}) {
    contact {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation UpdateContact { updateContact(input: {id: \"<contact id>\"}) { contact { id formattedName title modified } } }"}'
MUTATIONbulkUpdateContact(input: [CreateOrUpdateContactInput!]!, deleteInput: [DeleteContactInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateContactPayload
Example
Example: bulkUpdateContact
mutation BulkUpdateContact {
  bulkUpdateContact(input: [{id: "<contact id>"}]) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkUpdateContact { bulkUpdateContact(input: [{id: \"<contact id>\"}]) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONdeleteContact(input: DeleteContactInput!)Soft-deleteDeleteContactPayload
Example
Example: deleteContact
mutation DeleteContact {
  deleteContact(input: {id: "<contact id>"}) {
    contact {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation DeleteContact { deleteContact(input: {id: \"<contact id>\"}) { contact { id formattedName title modified } } }"}'
MUTATIONbulkArchiveContact(input: BulkArchiveContactInput!)Archive many GraphQL onlyBulkArchiveContactPayload
Example
Example: bulkArchiveContact
mutation BulkArchiveContact {
  bulkArchiveContact(
    input: {bulkFilter: {includedIds: ["<contact id>"]}, entity: {id: "<contact id>"}}
  ) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkArchiveContact { bulkArchiveContact( input: {bulkFilter: {includedIds: [\"<contact id>\"]}, entity: {id: \"<contact id>\"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONbulkReactivateContact(input: BulkReactivateContactInput!)Undo archive for many GraphQL onlyBulkReactivateContactPayload
Example
Example: bulkReactivateContact
mutation BulkReactivateContact {
  bulkReactivateContact(input: {bulkFilter: {includedIds: ["<contact id>"]}}) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkReactivateContact { bulkReactivateContact(input: {bulkFilter: {includedIds: [\"<contact id>\"]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONconvertContact(input: CreateContactInput!, sourceEntity: EntityNameEnum!, sourceEntityId: UUID!, operation: RecordConversionOperationEnum!, options: RecordConversionOptions!, sourceEntityApiName: String, validationLevel: [ValidationLevel!])Create from another record GraphQL onlyConvertContactPayload
Example
Example: convertContact
mutation ConvertContact {
  convertContact(
    input: {ownerId: "<owner id>"}
    sourceEntity: AiAgent
    sourceEntityId: "<source entity id>"
    operation: Nothing
    options: {}
  ) {
    contact {
      id
      formattedName
      title
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ConvertContact { convertContact( input: {ownerId: \"<owner id>\"} sourceEntity: AiAgent sourceEntityId: \"<source entity id>\" operation: Nothing options: {} ) { contact { id formattedName title modified } } }"}'

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

ContactEntity object 70 fields: customFields, pendingScheduledActions, isDeleteProtected, …

Person the sales team works with, usually linked to one or more accounts, leads and opportunities.

FieldTypeDescription
customFieldsJSONString! (1 args)Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
pendingScheduledActionsIntFilled only when a single record is read by its id; otherwise null or an empty list.
isDeleteProtectedBoolean!True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
contactTypeContactTypeEntityContact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply.
currencyExchangeRatesListCurrencyExchangeRatesListEntityCurrency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default.
ownerClientEntitySales user who owns this contact.
pictureCloudObjectEntityProfile picture associated with the contact.
unitSalesUnitEntitySales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing.
addressStringStreet address of the contact.
cityStringCity of the contact address.
commentsStringFree-form notes describing the contact.
contactTypeIdIDId of the contact type assigned to this contact.
countryStringCountry of the contact address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this contact.
email1StringPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
firstNameStringGiven name of the contact.
genderGenderEnumGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedBooleanTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameStringFamily name of the contact.
middleNameStringMiddle name of the contact, if applicable.
ownerIdID!Id of the contact owner.
phone1StringPrimary phone number of the contact. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
positionStringJob title or position of the contact.
quickAccountNameStringFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the contact address.
titleStringHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the contact address.
revisionIntRevision when entity was lastly changed.
formattedNameString!Display version of the contact name (title, first, middle, last). Used in lists and references.
enrolledEmailSequencesInt!Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
socialMediaContactSocialRelationEntitySocial network profiles linked to this contact (e.g. LinkedIn, Facebook).
primaryAccountAccountEntityPrimary account this contact belongs to. Set automatically when the contact has an account relation marked as primary.
accountRelationsContactAccountRelationEntityConnection (8 args)Accounts this contact is linked to. Each link records the role and position the contact has at the related account.
sharingUnitsContactSharingSalesUnitRelationEntityConnection (8 args)Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing.
sharingClientsContactSharingClientRelationEntityConnection (8 args)Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing.
documentsCloudObjectRelationEntityConnection (8 args)Documents linked to this contact.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
isFavoriteBoolean!True when the current authenticated user has marked this contact as favorite. Per-user.
primaryAccountAccountRoles[ContactAccountAccountRoleRelationEntity!]Roles of Contact in his primary Account.
primaryAccountPositionStringJob position of Contact in his primary Account.
accountPositionStringJob position of Contact in his primary Account or quick account position if Contact has no primary Account.
viewerIdsPerSalesUnit[UUID!]!Filled only when a single record is read by its id; otherwise null or an empty list.
isUnsubscribedBooleanIf account has any unsubscribed email.
tagsTagRelationEntityConnection (8 args)Tag labels applied to this contact.
staticProfilesProfileRelationEntityConnection (8 args)Saved view profiles this contact currently matches.
primaryAccountRelationshipStringOrg chart relationship of Contact in his primary Account.
modifiedByUserDateTimeTimestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
relatedEntitiesDrilldownCompactViewDrilldownModel! (1 args)Records of the given entity type that are related to this record, as a drilldown list.
charts[DashboardChartData!] (1 args)Data of the given preview pane charts and lists, computed for this record.
chartsDrilldownCompactViewDrilldownModel! (3 args)Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart.
fields[InterfaceFieldData]! (2 args)Values of the fields shown in the record's preview pane, as configured for the record's type.
approvalApprovalEntityApproval request of this record that is pending or was rejected; null when there is none or it was approved.
ContactEntityConnection object pageInfo: PageInfo!, edges: [ContactEntityEdge]!, totalCount: Int

Paginated list of Contact records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[ContactEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
ContactEntityEdge object node: ContactEntity, cursor: String!

A Relay edge containing a ContactEntity and its cursor.

FieldTypeDescription
nodeContactEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
ContactFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for Contact records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input fieldTypeDescription
OR[ContactFilterInput!]Matches records that meet at least one of the listed filters.
AND[ContactFilterInput!]Matches records that meet all of the listed filters.
NOTContactFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
addressEntityFilterStringFieldStreet address of the contact.
cityEntityFilterStringFieldCity of the contact address.
commentsEntityFilterStringFieldFree-form notes describing the contact.
contactTypeIdEntityFilterStringFieldId of the contact type assigned to this contact.
countryEntityFilterStringFieldCountry of the contact address.
currencyExchangeRatesListIdEntityFilterStringFieldId of the currency exchange rate list applied to this contact.
email1EntityFilterStringFieldPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2EntityFilterStringFieldAdditional email address.
email3EntityFilterStringFieldAdditional email address.
email4EntityFilterStringFieldAdditional email address.
email5EntityFilterStringFieldAdditional email address.
firstNameEntityFilterStringFieldGiven name of the contact.
genderGenderEnumFilterInputGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedBooleanTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameEntityFilterStringFieldFamily name of the contact.
middleNameEntityFilterStringFieldMiddle name of the contact, if applicable.
ownerIdEntityFilterStringFieldId of the contact owner.
phone1EntityFilterStringFieldPrimary phone number of the contact. Used as default target for click-to-call.
phone2EntityFilterStringFieldAdditional phone number.
phone3EntityFilterStringFieldAdditional phone number.
phone4EntityFilterStringFieldAdditional phone number.
phone5EntityFilterStringFieldAdditional phone number.
pictureIdEntityFilterStringFieldId of the profile picture document.
positionEntityFilterStringFieldJob title or position of the contact.
quickAccountNameEntityFilterStringFieldFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeShareModeEnumFilterInputSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceEntityFilterStringFieldState or province of the contact address.
titleEntityFilterStringFieldHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdEntityFilterStringFieldId of the sales unit.
zipCodeEntityFilterStringFieldZIP or postal code of the contact address.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
enrolledEmailSequencesIntNumber of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
relatedEntities[EntityFilterRelatedField]Matches records related to at least one of the listed records.
withCustom[CustomField!]Conditions on custom fields, each identified by its api name. All listed conditions must match.
contactTypeContactTypeFilterInputContact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. Matches records where a related record meets these conditions.
currencyExchangeRatesListCurrencyExchangeRatesListFilterInputCurrency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. Matches records where a related record meets these conditions.
ownerClientFilterInputSales user who owns this contact. Matches records where a related record meets these conditions.
pictureCloudObjectFilterInputProfile picture associated with the contact. Matches records where a related record meets these conditions.
unitSalesUnitFilterInputSales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions.
socialMediaContactSocialRelationFilterInputSocial network profiles linked to this contact (e.g. LinkedIn, Facebook). Matches records where a related record meets these conditions.
primaryAccountAccountFilterInputPrimary account this contact belongs to. Set automatically when the contact has an account relation marked as primary. Matches records where a related record meets these conditions.
accountRelationsContactAccountRelationFilterInputAccounts this contact is linked to. Each link records the role and position the contact has at the related account. Matches records where a related record meets these conditions.
sharingUnitsContactSharingSalesUnitRelationFilterInputSales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions.
sharingClientsContactSharingClientRelationFilterInputUsers that have been granted shared access to this contact. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions.
documentsCloudObjectRelationFilterInputDocuments linked to this contact. Matches records where a related record meets these conditions.
tagsTagRelationFilterInputTag labels applied to this contact. Matches records where a related record meets these conditions.
staticProfilesProfileRelationFilterInputSaved view profiles this contact currently matches. Matches records where a related record meets these conditions.
ContactOrderByInput input Asc or Desc per field

Sorting of Contact records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
contactType[ContactTypeOrderByNestedInput!]Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. Sorts by fields of the related record, listed in order of priority.
currencyExchangeRatesList[CurrencyExchangeRatesListOrderByNestedInput!]Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority.
owner[ClientOrderByNestedInput!]Sales user who owns this contact. Sorts by fields of the related record, listed in order of priority.
unit[SalesUnitOrderByNestedInput!]Sales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority.
addressOrderByEnumStreet address of the contact.
cityOrderByEnumCity of the contact address.
commentsOrderByEnumFree-form notes describing the contact.
contactTypeIdOrderByEnumId of the contact type assigned to this contact.
countryOrderByEnumCountry of the contact address.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this contact.
email1OrderByEnumPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2OrderByEnumAdditional email address.
email3OrderByEnumAdditional email address.
email4OrderByEnumAdditional email address.
email5OrderByEnumAdditional email address.
firstNameOrderByEnumGiven name of the contact.
genderOrderByEnumGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedOrderByEnumTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameOrderByEnumFamily name of the contact.
middleNameOrderByEnumMiddle name of the contact, if applicable.
ownerIdOrderByEnumId of the contact owner.
phone1OrderByEnumPrimary phone number of the contact. Used as default target for click-to-call.
phone2OrderByEnumAdditional phone number.
phone3OrderByEnumAdditional phone number.
phone4OrderByEnumAdditional phone number.
phone5OrderByEnumAdditional phone number.
positionOrderByEnumJob title or position of the contact.
quickAccountNameOrderByEnumFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeOrderByEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceOrderByEnumState or province of the contact address.
titleOrderByEnumHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdOrderByEnumId of the sales unit.
zipCodeOrderByEnumZIP or postal code of the contact address.
revisionOrderByEnumRevision when entity was lastly changed.
enrolledEmailSequencesOrderByEnumNumber of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
socialMedia[ContactSocialRelationOrderByNestedInput!]Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Sorts by fields of the related record, listed in order of priority.
exchangeEntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
relatedEntitiesCommonEntityRepositoryOrderByEntityRelationFieldSorts records by whether they are related to the listed records.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
GenderEnumFilterInput input eq: [GenderEnum!], NOT: GenderEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[GenderEnum!]Matches any of the listed values.
NOTGenderEnumFilterInputMatches values that do not meet this condition.
ArchiveContactInput input 9 fields: entity, archiveAllRelatedLeads, archiveAllRelatedOpportunities, …

Parameters of the archiveContact mutation.

Input fieldTypeDescription
entityUpdateContactInput!Id of the contact and optional field values to save together with the archive.
archiveAllRelatedLeadsBoolean!Archives open leads whose primary contact is this contact.
archiveAllRelatedOpportunitiesBoolean!Archives open opportunities whose primary contact is this contact.
archiveAllRelatedQuotesBoolean!Archives open quotes whose primary contact is this contact.
completeAllRelatedTasksBoolean!Marks all tasks linked to the contact as completed.
completeAllRelatedLeadsTasksBooleanMarks tasks of leads whose primary contact is this contact as completed.
completeAllRelatedOpportunitiesTasksBooleanMarks tasks of opportunities whose primary contact is this contact as completed.
completeAllRelatedQuotesTasksBooleanMarks tasks of quotes whose primary contact is this contact as completed.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkArchiveContactInput input 11 fields: bulkFilter, entity, archiveAllRelatedLeads, …

Parameters of the bulkArchiveContact mutation.

Input fieldTypeDescription
bulkFilterBulkOperationInput!Contacts to archive: includedIds minus excludedIds. Integrations can leave sessionId empty.
entityCreateOrUpdateContactInput!Field values saved on every archived contact.
archiveAllRelatedLeadsBooleanArchives open leads whose primary contact is one of the contacts.
archiveAllRelatedOpportunitiesBooleanArchives open opportunities whose primary contact is one of the contacts.
archiveAllRelatedQuotesBooleanArchives open quotes whose primary contact is one of the contacts.
completeAllRelatedTasksBooleanMarks all tasks linked to each contact as completed.
completeAllRelatedLeadsTasksBooleanMarks tasks of the contacts' leads as completed.
completeAllRelatedOpportunitiesTasksBooleanMarks tasks of the contacts' opportunities as completed.
completeAllRelatedQuotesTasksBooleanMarks tasks of the contacts' quotes as completed.
rollbackMethodRollbackMethodROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkReactivateContactInput input bulkFilter: BulkOperationInput!, rollbackMethod: RollbackMethod, clientMutationId: String

Parameters of the bulkReactivateContact mutation.

Input fieldTypeDescription
bulkFilterBulkOperationInput!Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty.
rollbackMethodRollbackMethodROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ChangeOwnershipContactInput input 6 fields: ownerId, unitId, keepOwnerAsEditor, …

Parameters of the changeOwnershipContact mutation.

Input fieldTypeDescription
ownerIdID!User who becomes the new owner of the contact.
unitIdID!Sales unit the contact is assigned to.
keepOwnerAsEditorBoolean!When true, the previous owner (if still an active user) stays on the contact as a shared user with the Editor role, and a Private sharing mode is switched to Standard.
transferLinkedRecordsBoolean!When true, the new owner and sales unit are also applied to the contact's open tasks and appointments, its notes and its open leads and opportunities. Linked records that cannot be transferred are skipped without failing the mutation.
idID!Identifier of the ContactEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ContactSocialRelationOrderByNestedInput input 27 fields: id, isDeleted, modified, …

Sorting by a field of the related ContactSocialRelation record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity. Must match with Contact id.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
angellistUrlOrderByEnumAngelList profile URL of the contact.
crunchbaseUrlOrderByEnumCrunchbase profile URL of the contact.
disqusUrlOrderByEnumDisqus profile URL of the contact.
facebookUrlOrderByEnumFacebook profile URL of the contact.
flickrUrlOrderByEnumFlickr profile URL of the contact.
foursquareUrlOrderByEnumFoursquare profile URL of the contact.
googlePlusUrlOrderByEnumGoogle+ profile URL of the contact.
gravatarUrlOrderByEnumGravatar profile URL of the contact.
kloutUrlOrderByEnumKlout profile URL of the contact.
linkedinUrlOrderByEnumLinkedIn profile URL of the contact.
pinterestUrlOrderByEnumPinterest profile URL of the contact.
quoraUrlOrderByEnumQuora profile URL of the contact.
redditUrlOrderByEnumReddit profile URL of the contact.
skypeUrlOrderByEnumSkype contact URL or username of the contact.
slideshareUrlOrderByEnumSlideShare profile URL of the contact.
twitterUrlOrderByEnumTwitter (X) profile URL of the contact.
vimeoUrlOrderByEnumVimeo profile URL of the contact.
wordpressUrlOrderByEnumWordPress site URL of the contact.
xingUrlOrderByEnumXING profile URL of the contact.
yahooUrlOrderByEnumYahoo profile URL of the contact.
yelpUrlOrderByEnumYelp profile URL of the contact.
youtubeUrlOrderByEnumYouTube channel URL of the contact.
revisionOrderByEnumRevision when entity was lastly changed.
CopyContactInput input skipCopySuffix: Boolean, id: ID!, clientMutationId: String

Parameters of the copyContact mutation.

Input fieldTypeDescription
skipCopySuffixBooleanWhen true, the copy keeps the original name without the copy suffix. Defaults to false.
idID!Identifier of the ContactEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CreateContactAccountRelationNoContactBackrefInput input 11 fields: modified, created, accountId, …

Field values of a new ContactAccountRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdID!Id of the account the contact is linked to.
commentStringFree-form note describing this contact-account link.
isAssistantBooleanTrue when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
isPrimaryBoolean!True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row.
isSiblingBooleanTrue when the contact is a sibling node on the account org chart (no parent/child reporting line).
positionStringJob title or position the contact holds at the account.
relationshipOrgRelationshipTypeEnumOrg-chart relationship of the contact within the account hierarchy.
revisionIntRevision when entity was lastly changed.
accountRoles[CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!]Roles the contact holds within the linked account.
CreateContactInput input 47 fields: clientMutationId, modified, created, …

Field values of a new Contact record.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pictureCreateCloudObjectInputProfile picture associated with the contact.
addressStringStreet address of the contact.
cityStringCity of the contact address.
commentsStringFree-form notes describing the contact.
contactTypeIdIDId of the contact type assigned to this contact.
countryStringCountry of the contact address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this contact.
email1StringPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
firstNameStringGiven name of the contact.
genderGenderEnumGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedBooleanTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameStringFamily name of the contact.
middleNameStringMiddle name of the contact, if applicable.
ownerIdID!Id of the contact owner.
phone1StringPrimary phone number of the contact. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
positionStringJob title or position of the contact.
quickAccountNameStringFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the contact address.
titleStringHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the contact address.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
socialMediaCreateContactSocialRelationNoIdBackrefInputSocial network profiles linked to this contact (e.g. LinkedIn, Facebook).
accountRelations[CreateContactAccountRelationNoContactBackrefInput!]Accounts this contact is linked to. Each link records the role and position the contact has at the related account.
sharingUnits[CreateContactSharingSalesUnitRelationNoContactBackrefInput!]Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing.
sharingClients[CreateContactSharingClientRelationNoContactBackrefInput!]Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this contact.
primaryAccountAccountRoles[UUID!]Roles of Contact in his primary Account.
accountPositionStringJob position of Contact in his primary Account or quick account position if Contact has no primary Account.
isUnsubscribedBooleanIf account has any unsubscribed email.
tags[CreateTagRelationNoContactBackrefInput!]Tag labels applied to this contact.
staticProfiles[CreateProfileRelationNoContactBackrefInput!]Saved view profiles this contact currently matches.
primaryAccountRelationshipStringOrg chart relationship of Contact in his primary Account.
CreateContactSharingClientRelationNoContactBackrefInput input 5 fields: modified, created, clientId, …

Field values of a new ContactSharingClientRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
clientIdID!Id of the user.
roleSharingRoleEnumAccess the sharing gives the user on the contact: Watcher can view it, Editor can view and edit it.
revisionIntRevision when entity was lastly changed.
CreateContactSharingSalesUnitRelationNoContactBackrefInput input 5 fields: modified, created, role, …

Field values of a new ContactSharingSalesUnitRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
roleSharingRoleEnumAccess the sharing gives the sales unit on the contact: Watcher can view it, Editor can view and edit it.
unitIdID!Id of the sales unit.
revisionIntRevision when entity was lastly changed.
CreateContactSocialRelationNoIdBackrefInput input 29 fields: modified, created, angellistUrl, …

Field values of a new ContactSocialRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
angellistUrlStringAngelList profile URL of the contact.
crunchbaseUrlStringCrunchbase profile URL of the contact.
disqusUrlStringDisqus profile URL of the contact.
facebookIdStringFacebook profile id of the contact.
facebookUrlStringFacebook profile URL of the contact.
flickrUrlStringFlickr profile URL of the contact.
foursquareUrlStringFoursquare profile URL of the contact.
googleIdStringGoogle profile id of the contact.
googlePlusUrlStringGoogle+ profile URL of the contact.
gravatarUrlStringGravatar profile URL of the contact.
kloutUrlStringKlout profile URL of the contact.
linkedinIdStringLinkedIn profile id of the contact.
linkedinUrlStringLinkedIn profile URL of the contact.
pinterestUrlStringPinterest profile URL of the contact.
quoraUrlStringQuora profile URL of the contact.
redditUrlStringReddit profile URL of the contact.
skypeUrlStringSkype contact URL or username of the contact.
slideshareUrlStringSlideShare profile URL of the contact.
twitterIdStringTwitter (X) user id of the contact.
twitterUrlStringTwitter (X) profile URL of the contact.
vimeoUrlStringVimeo profile URL of the contact.
wordpressUrlStringWordPress site URL of the contact.
xingUrlStringXING profile URL of the contact.
yahooUrlStringYahoo profile URL of the contact.
yelpUrlStringYelp profile URL of the contact.
youtubeUrlStringYouTube channel URL of the contact.
revisionIntRevision when entity was lastly changed.
CreateOrUpdateContactInput input 51 fields: clientMutationId, id, modified, …

Field values of a Contact record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pictureCreateCloudObjectInputProfile picture associated with the contact.
addressStringStreet address of the contact.
cityStringCity of the contact address.
commentsStringFree-form notes describing the contact.
contactTypeIdIDId of the contact type assigned to this contact.
countryStringCountry of the contact address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this contact.
email1StringPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
firstNameStringGiven name of the contact.
genderGenderEnumGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedBooleanTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameStringFamily name of the contact.
middleNameStringMiddle name of the contact, if applicable.
ownerIdIDId of the contact owner.
phone1StringPrimary phone number of the contact. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
positionStringJob title or position of the contact.
quickAccountNameStringFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the contact address.
titleStringHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the contact address.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
socialMediaUpdateContactSocialRelationNoIdBackrefInputSocial network profiles linked to this contact (e.g. LinkedIn, Facebook).
accountRelations[CreateContactAccountRelationNoContactBackrefInput!]Accounts this contact is linked to. Each link records the role and position the contact has at the related account.
sharingUnits[CreateContactSharingSalesUnitRelationNoContactBackrefInput!]Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing.
sharingClients[CreateContactSharingClientRelationNoContactBackrefInput!]Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this contact.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
primaryAccountAccountRoles[UUID!]Roles of Contact in his primary Account.
accountPositionStringJob position of Contact in his primary Account or quick account position if Contact has no primary Account.
isUnsubscribedBooleanIf account has any unsubscribed email.
tags[CreateTagRelationNoContactBackrefInput!]Tag labels applied to this contact.
staticProfiles[CreateProfileRelationNoContactBackrefInput!]Saved view profiles this contact currently matches.
primaryAccountRelationshipStringOrg chart relationship of Contact in his primary Account.
CreateProfileRelationNoContactBackrefInput input 8 fields: modified, created, accountId, …

Field values of a new ProfileRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdIDId of the linked account.
customEntityIdIDId of the linked custom entity record.
leadOpptyIdIDId of the linked lead or opportunity, or empty when not pointing to one.
profileIdID!Id of the screen profile.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
CreateTagRelationNoContactBackrefInput input 15 fields: modified, created, accountId, …

Field values of a new TagRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdIDId of the linked account.
appointmentIdIDId of the linked appointment.
customEntityIdIDId of the linked custom entity record.
emailIdIDId of the linked email.
leadIdIDId of the linked lead.
opptyIdIDId of the linked opportunity.
processIdIDId of the linked sales process.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
solutionIdIDId of the linked solution.
tagIdID!Id of the tag attached to the record.
taskIdIDId of the linked task.
revisionIntRevision when entity was lastly changed.
DeleteContactInput input clientMutationId: String, id: ID!

Id of the Contact record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
ManageSharingContactInput input 5 fields: shareMode, sharingClients, sharingUnits, …

Parameters of the manageSharingContact mutation.

Input fieldTypeDescription
shareModeShareModeEnum!Sharing mode of the record: Standard, Private, AllView or AllEdit.
sharingClients[CreateContactSharingClientRelationNoContactBackrefInput!]Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users.
sharingUnits[CreateContactSharingSalesUnitRelationNoContactBackrefInput!]Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units.
idID!Identifier of the ContactEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
MergeContactInput input master: UpdateContactInput!, slaveId: ID!, clientMutationId: String

Parameters of the mergeContact mutation.

Input fieldTypeDescription
masterUpdateContactInput!Id of the contact to keep and the field values it should end up with.
slaveIdID!Id of the duplicate contact that is merged into the master and then deleted.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ReactivateContactInput input id: UUID!, clientMutationId: String

Parameters of the reactivateContact mutation.

Input fieldTypeDescription
idUUID!Id of the archived contact.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RestoreContactInput input id: ID!, clientMutationId: String

Parameters of the restoreContact mutation.

Input fieldTypeDescription
idID!Identifier of the ContactEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateContactInput input 51 fields: clientMutationId, id, modified, …

Id of a Contact record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pictureCreateCloudObjectInputProfile picture associated with the contact.
addressStringStreet address of the contact.
cityStringCity of the contact address.
commentsStringFree-form notes describing the contact.
contactTypeIdIDId of the contact type assigned to this contact.
countryStringCountry of the contact address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this contact.
email1StringPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
firstNameStringGiven name of the contact.
genderGenderEnumGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedBooleanTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameStringFamily name of the contact.
middleNameStringMiddle name of the contact, if applicable.
ownerIdIDId of the contact owner.
phone1StringPrimary phone number of the contact. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
positionStringJob title or position of the contact.
quickAccountNameStringFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the contact address.
titleStringHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the contact address.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
socialMediaUpdateContactSocialRelationNoIdBackrefInputSocial network profiles linked to this contact (e.g. LinkedIn, Facebook).
accountRelations[CreateContactAccountRelationNoContactBackrefInput!]Accounts this contact is linked to. Each link records the role and position the contact has at the related account.
sharingUnits[CreateContactSharingSalesUnitRelationNoContactBackrefInput!]Sales units that have been granted shared access to this contact. Editable only when shareMode allows unit sharing.
sharingClients[CreateContactSharingClientRelationNoContactBackrefInput!]Users that have been granted shared access to this contact. Editable only when shareMode allows user sharing.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this contact.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
primaryAccountAccountRoles[UUID!]Roles of Contact in his primary Account.
accountPositionStringJob position of Contact in his primary Account or quick account position if Contact has no primary Account.
isUnsubscribedBooleanIf account has any unsubscribed email.
tags[CreateTagRelationNoContactBackrefInput!]Tag labels applied to this contact.
staticProfiles[CreateProfileRelationNoContactBackrefInput!]Saved view profiles this contact currently matches.
primaryAccountRelationshipStringOrg chart relationship of Contact in his primary Account.
UpdateContactSocialRelationNoIdBackrefInput input 29 fields: modified, created, angellistUrl, …

Id of a ContactSocialRelation record and the field values to change, updated together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
angellistUrlStringAngelList profile URL of the contact.
crunchbaseUrlStringCrunchbase profile URL of the contact.
disqusUrlStringDisqus profile URL of the contact.
facebookIdStringFacebook profile id of the contact.
facebookUrlStringFacebook profile URL of the contact.
flickrUrlStringFlickr profile URL of the contact.
foursquareUrlStringFoursquare profile URL of the contact.
googleIdStringGoogle profile id of the contact.
googlePlusUrlStringGoogle+ profile URL of the contact.
gravatarUrlStringGravatar profile URL of the contact.
kloutUrlStringKlout profile URL of the contact.
linkedinIdStringLinkedIn profile id of the contact.
linkedinUrlStringLinkedIn profile URL of the contact.
pinterestUrlStringPinterest profile URL of the contact.
quoraUrlStringQuora profile URL of the contact.
redditUrlStringReddit profile URL of the contact.
skypeUrlStringSkype contact URL or username of the contact.
slideshareUrlStringSlideShare profile URL of the contact.
twitterIdStringTwitter (X) user id of the contact.
twitterUrlStringTwitter (X) profile URL of the contact.
vimeoUrlStringVimeo profile URL of the contact.
wordpressUrlStringWordPress site URL of the contact.
xingUrlStringXING profile URL of the contact.
yahooUrlStringYahoo profile URL of the contact.
yelpUrlStringYelp profile URL of the contact.
youtubeUrlStringYouTube channel URL of the contact.
revisionIntRevision when entity was lastly changed.
ArchiveContactPayload object result: ContactEntity, clientMutationId: String

Result of the archiveContact mutation.

FieldTypeDescription
resultContactEntityThe archived contact.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkArchiveContactPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkArchiveContact mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the archived contacts and the items that failed.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkReactivateContactPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkReactivateContact mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the reactivated records and the items that failed.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkUpdateContactPayload object result: BulkUpdateResults!

Result of the bulkUpdateContact mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
ChangeOwnershipContactPayload object result: ContactEntity, clientMutationId: String

Result of the changeOwnershipContact mutation.

FieldTypeDescription
resultContactEntityThe contact with its new owner.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ConvertContactPayload object contact: ContactEntity!, clientMutationId: String

Result of the convertContact mutation.

FieldTypeDescription
contactContactEntity!The created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CopyContactPayload object result: ContactEntity, clientMutationId: String

Result of the copyContact mutation.

FieldTypeDescription
resultContactEntityThe new contact.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CreateContactPayload object contact: ContactEntity, clientMutationId: String

Result of the createContact mutation.

FieldTypeDescription
contactContactEntityThe created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
DeleteContactPayload object contact: ContactEntity, clientMutationId: String

Result of the deleteContact mutation.

FieldTypeDescription
contactContactEntityThe deleted record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ManageSharingContactPayload object result: ContactEntity, clientMutationId: String

Result of the manageSharingContact mutation.

FieldTypeDescription
resultContactEntityThe record with its updated sharing.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
MergeContactPayload object result: ContactEntity, clientMutationId: String

Result of the mergeContact mutation.

FieldTypeDescription
resultContactEntityThe merged master contact.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ReactivateContactPayload object result: ContactEntity, clientMutationId: String

Result of the reactivateContact mutation.

FieldTypeDescription
resultContactEntityThe reactivated contact.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RestoreContactPayload object result: ContactEntity, clientMutationId: String

Result of the restoreContact mutation.

FieldTypeDescription
resultContactEntityThe restored record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateContactPayload object contact: ContactEntity, clientMutationId: String

Result of the updateContact mutation.

FieldTypeDescription
contactContactEntityThe updated record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ContactAutoPrefill object entity: ContactEntity, fieldIds: [UUID!]!

New, unsaved contact pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in.

FieldTypeDescription
entityContactEntityNew contact carrying the pre-filled values; it is not saved.
fieldIds[UUID!]!Ids of the fields that were filled in.
GenderEnum enum Unknown, Male, Female, NonBinary

Gender of a contact.

ValueDescription
UnknownGender is not specified.
MaleThe contact is male.
FemaleThe contact is female.
NonBinaryThe contact is non-binary.