customerDeactivateTeamMember

Requires a customer (portal or buyer app) session.

Deactivate a teammate (CUSTOMER_ADMIN only). The last active CUSTOMER_ADMIN is protected (LAST_OWNER_PROTECTED). screen 16.

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 CustomerDeactivateTeamMember($userId: ID!) {
  customerDeactivateTeamMember(userId: $userId)
}

cURL

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

Variables:

{
  "userId": "id"
}

Response:

{
  "data": {
    "customerDeactivateTeamMember": true
  }
}

customerDeactivateTeamMember(
  userId: ID!
): Boolean!

Arguments

customerDeactivateTeamMember.userId ● ID! non-null scalar

The ID of the user.

Type

Boolean scalar

The Boolean scalar type represents true or false.