companyContactsDelete

mutation

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Deletes one or more company contacts.

Arguments

Anchor to companyContactIdscompanyContactIds • [ID!]!required: The list of IDs of the company contacts to delete.

Was this section helpful?

Anchor to CompanyContactsDeletePayload returnsCompanyContactsDeletePayload returns

Anchor to deletedCompanyContactIdsdeletedCompanyContactIds • [ID!]: The list of IDs of the deleted company contacts.
Anchor to userErrorsuserErrors • [BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation companyContactsDelete($companyContactIds: [ID!]!) {
2  companyContactsDelete(companyContactIds: $companyContactIds) {
3    deletedCompanyContactIds
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "companyContactIds": [
3    "gid://shopify/<objectName>/10079785100"
4  ]
5}

{
  "companyContactIds": [
    "gid://shopify/<objectName>/10079785100"
  ]
}