c.l.cladDocs

CRM — accounts & contacts

Every account and contact query and mutation, plus saved views and custom fields.

Read and write CRM accounts and contacts, saved account views, and account/contact custom fields.

Queries

account

account(id: ID!): Account
ArgumentTypeDescription
idID!Required.

accounts

accounts(after: String, first: Int, search: String): AccountConnection
ArgumentTypeDescription
afterString
firstInt
searchString

accountViews

accountViews: [AccountView!]

Saved account views (filters) for the organization.

contact

contact(id: ID!): Contact
ArgumentTypeDescription
idID!Required.

contacts

contacts(accountId: ID, after: String, first: Int, search: String): ContactConnection
ArgumentTypeDescription
accountIdID
afterString
firstInt
searchString

customFields

customFields(entity: CustomFieldEntity!): [CustomField!]
ArgumentTypeDescription
entityCustomFieldEntity!Required.

Mutations

createAccount

createAccount(input: CreateAccountInput!): AccountResult
ArgumentTypeDescription
inputCreateAccountInput!Required.

createAccountView

createAccountView(input: CreateAccountViewInput!): AccountViewResult

Create a saved account view (filter). The org's first view is auto-starred.

ArgumentTypeDescription
inputCreateAccountViewInput!Required.

createContact

createContact(input: CreateContactInput!): ContactResult
ArgumentTypeDescription
inputCreateContactInput!Required.

createCustomField

createCustomField(input: CreateCustomFieldInput!): CustomFieldResult
ArgumentTypeDescription
inputCreateCustomFieldInput!Required.

deleteAccount

deleteAccount(id: ID!): DeleteAccountResult

Hard-delete a CRM account. Contacts keep existing; issues are not touched.

ArgumentTypeDescription
idID!Required.

deleteAccountView

deleteAccountView(id: ID!): DeleteAccountViewResult

Delete a saved account view.

ArgumentTypeDescription
idID!Required.

deleteContact

deleteContact(id: ID!): DeleteContactResult

Hard-delete a CRM contact.

ArgumentTypeDescription
idID!Required.

deleteCustomField

deleteCustomField(input: DeleteCustomFieldInput!): DeleteCustomFieldResult
ArgumentTypeDescription
inputDeleteCustomFieldInput!Required.

updateAccount

updateAccount(input: UpdateAccountInput!): AccountResult
ArgumentTypeDescription
inputUpdateAccountInput!Required.

updateAccountView

updateAccountView(input: UpdateAccountViewInput!): AccountViewResult

Rename, reconfigure, or star/unstar a saved account view.

ArgumentTypeDescription
inputUpdateAccountViewInput!Required.

updateContact

updateContact(input: UpdateContactInput!): ContactResult
ArgumentTypeDescription
inputUpdateContactInput!Required.

updateCustomField

updateCustomField(input: UpdateCustomFieldInput!): CustomFieldResult
ArgumentTypeDescription
inputUpdateCustomFieldInput!Required.