setCommissionRoleRate

Requires permission commissions:commission:update.

Sets the commission rate of one role, between 0 and 100 percent. Every role needs its own rate: an active rate above zero cannot equal another role's active rate. Requires permission to update 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 SetCommissionRoleRate($input: SetCommissionRoleRateInput!) {
  setCommissionRoleRate(input: $input) {
    id
    isActive
    rate
    role
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetCommissionRoleRate($input: SetCommissionRoleRateInput!) {\n  setCommissionRoleRate(input: $input) {\n    id\n    isActive\n    rate\n    role\n  }\n}",
  "variables": {
    "input": {
      "rate": 0,
      "role": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "rate": 0,
    "role": "string"
  }
}

Response:

{
  "data": {
    "setCommissionRoleRate": {
      "id": "id",
      "isActive": true,
      "rate": 0,
      "role": "string"
    }
  }
}

setCommissionRoleRate(
  input: SetCommissionRoleRateInput!
): CommissionRoleRate!

Arguments

setCommissionRoleRate.input ● SetCommissionRoleRateInput! non-null input

The role, the rate and whether it is active.

Type

CommissionRoleRate object

The commission rate set for one role. Every chain member with the role earns it.