deleteCommissionRoleRate

Requires permission commissions:commission:delete.

Removes a role's commission rate. Fails if the role has no rate. Requires permission to delete commissions.

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 DeleteCommissionRoleRate($role: String!) {
  deleteCommissionRoleRate(role: $role)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteCommissionRoleRate($role: String!) {\n  deleteCommissionRoleRate(role: $role)\n}",
  "variables": {
    "role": "string"
  }
}
EOF

Variables:

{
  "role": "string"
}

Response:

{
  "data": {
    "deleteCommissionRoleRate": true
  }
}

deleteCommissionRoleRate(
  role: String!
): Boolean!

Arguments

deleteCommissionRoleRate.role ● String! non-null scalar

The role whose rate to remove.

Type

Boolean scalar

The Boolean scalar type represents true or false.