companyDelete
mutation

Choose a version:

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 CompanyDeletePayload.deletedCompanyId deletedCompanyId ID: The ID of the deleted company.
Anchor to CompanyDeletePayload.userErrors userErrors [BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: companyDelete

Query Reference for MUTATION: companyDelete

"mutation companyDelete($id: ID!) {\n  companyDelete(id: $id) {\n    deletedCompanyId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyDelete

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

Schema Reference for MUTATION: companyDelete

""

Display Examples for MUTATION: companyDelete

[]