setRepCommissionRate

Requires permission commissions:commission:update.

Sets a sales rep's default commission rate and whether it is active. 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 SetRepCommissionRate($input: SetRepCommissionRateInput!) {
  setRepCommissionRate(input: $input) {
    id
    repName
    defaultRate
    isActive
    repEmail
    userId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetRepCommissionRate($input: SetRepCommissionRateInput!) {\n  setRepCommissionRate(input: $input) {\n    id\n    repName\n    defaultRate\n    isActive\n    repEmail\n    userId\n  }\n}",
  "variables": {
    "input": {
      "defaultRate": 0,
      "userId": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "defaultRate": 0,
    "userId": "string"
  }
}

Response:

{
  "data": {
    "setRepCommissionRate": {
      "id": "id",
      "repName": "string",
      "defaultRate": 0,
      "isActive": true,
      "repEmail": "string",
      "userId": "string"
    }
  }
}

setRepCommissionRate(
  input: SetRepCommissionRateInput!
): RepCommissionProfile!

Arguments

setRepCommissionRate.input ● SetRepCommissionRateInput! non-null input

The rep, the default rate and whether the profile is active.

Type

RepCommissionProfile object

A rep's commission setup.