{
"status": "success",
"code": 200,
"name": "OK",
"message": "User has been changed successfully!"
}{
"status": "error",
"code": 400,
"name": "Bad Request",
"message": "Request could not be parsed.",
"info": {
"errors": {}
}
}{
"status": "error",
"code": 401,
"name": "Unauthorized",
"message": "API key is invalid or missing."
}{
"status": "error",
"code": 403,
"name": "Forbidden",
"message": "This endpoint is not available for your role."
}{
"status": "error",
"code": 404,
"name": "Not Found",
"message": "Resource not found."
}{
"status": "error",
"code": 422,
"name": "Unprocessable entity",
"message": "Validation error",
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}{
"status": "error",
"code": 500,
"name": "Internal Server Error",
"message": "An unexpected error occurred.",
"info": {
"errors": {}
}
}Update a player or trader
Updates the player (iGaming) or trader (trading) found by click_id or adv_user_id, and can change the status of its commissions.
Brand workspaces of the iGaming (brand_gaming) and trading (brand_finance) verticals only, the two that have players and traders; in any other workspace the request answers 400.
change_commission_status changes the status of the player’s conversions that are not in any invoice yet. The change runs as an adjustment in the background and fires affiliate postbacks, like any other status change. commission_types limits it to the listed commission types; conversions of other types keep their status. Nothing to change is not an error: the request still answers 200.
{
"status": "success",
"code": 200,
"name": "OK",
"message": "User has been changed successfully!"
}{
"status": "error",
"code": 400,
"name": "Bad Request",
"message": "Request could not be parsed.",
"info": {
"errors": {}
}
}{
"status": "error",
"code": 401,
"name": "Unauthorized",
"message": "API key is invalid or missing."
}{
"status": "error",
"code": 403,
"name": "Forbidden",
"message": "This endpoint is not available for your role."
}{
"status": "error",
"code": 404,
"name": "Not Found",
"message": "Resource not found."
}{
"status": "error",
"code": 422,
"name": "Unprocessable entity",
"message": "Validation error",
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}{
"status": "error",
"code": 500,
"name": "Internal Server Error",
"message": "An unexpected error occurred.",
"info": {
"errors": {}
}
}Authorizations
Body
Either click_id or adv_user_id is required.
Commission types change_commission_status applies to. Omitted or []: every type. Case-insensitive, duplicates are ignored. Requires change_commission_status.
Each type is matched on the goals of the player's offer that hold it — the goal the commission plans write that type to (by alias), plus goals of the type's own goal type. Flat Fee has no goal type of its own, and goals with the flat or lot alias belong to no other type.
| Value | Commission type | Goals of the offer |
|---|---|---|
cpa | CPA | alias dep, or goal type CPA (2) |
revshare | RevShare | alias revshare, or goal type RevShare (8) |
cpl | CPL | alias lead, or goal type CPL (3) |
flat | Flat Fee | alias flat |
Lot-Based Fee (alias lot, broker workspaces) has no value here: a non-empty commission_types never touches it, so its commissions change only when commission_types is omitted or [].
If the offer has no goal of the requested types, nothing is changed and the request still answers 200.
Any value that is not an array of the values above — including "", 0, false and null — answers 422 Incorrect commission_types; commission_types without change_commission_status answers 422 change_commission_status is required when commission_types is set.
cpa, revshare, cpl, flat Was this page helpful?