customerDelete Mutation

Deletes a customer.

Requires the MANAGE_USERSpermission.

Triggers the following webhook events:

• CUSTOMER_DELETED (async): A customer account was deleted.

customerDelete(
  externalReference: String
  id: ID
): CustomerDelete

Details

type CustomerDelete {
  accountErrors: [AccountError!]! @deprecated
  errors: [AccountError!]!
  user: User
}

Arguments

externalReference ● String

External ID of a customer to update.

id ● ID

ID of a customer to delete.

Type

CustomerDelete

Deletes a customer.

Requires the MANAGE_USERSpermission.

Triggers the following webhook events:

• CUSTOMER_DELETED (async): A customer account was deleted.