deactivateCustomerUser

Requires permission customers:customer_user:delete.

Deactivates a customer user. Every sign-in route refuses them from then on, and their record stays. Needs customers:customer_user:delete.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation DeactivateCustomerUser($userId: ID!) {
  deactivateCustomerUser(userId: $userId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeactivateCustomerUser($userId: ID!) {\n  deactivateCustomerUser(userId: $userId)\n}",
  "variables": {
    "userId": "id"
  }
}
EOF

Variables:

{
  "userId": "id"
}

Response:

{
  "data": {
    "deactivateCustomerUser": true
  }
}

deactivateCustomerUser(
  userId: ID!
): Boolean!

Arguments

deactivateCustomerUser.userId ● ID! non-null scalar

The ID of the customer user.

Type

Boolean scalar

The Boolean scalar type represents true or false.