companyDelete

mutation

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

Deletes a company.

Arguments

Was this section helpful?

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

Was this section helpful?

1mutation companyDelete($id: ID!) {
2  companyDelete(id: $id) {
3    deletedCompanyId
4    userErrors {
5      field
6      message
7    }
8  }
9}

1{
2  "id": "gid://shopify/<objectName>/10079785100"
3}

{
  "id": "gid://shopify/<objectName>/10079785100"
}