companyDelete

Deletes a company.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the companyDelete action (under Company).
Fill in the fields below, then reference the result from later steps as {{companydelete.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CompanyDelete($id: ID!) {
  companyDelete(id: $id) {
    deletedCompanyId
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the company to delete.

json

{
  "id": "string"
}

Response

Read the result with {{companydelete.response.data.data.companyDelete}}. If the API returns errors, the step fails and they are at {{companydelete.response.data.errors}}.

deletedCompanyIdstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?