Skip to main content
PUT

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json

Either click_id or adv_user_id is required.

click_id
string

Click ID of the player or trader.

adv_user_id
string

Advertiser user ID of the player or trader. Used when click_id is not passed.

status
enum<string>
Available options:
active,
restricted
status_details
string
Maximum string length: 255
verified
enum<string>
Available options:
verified,
not_verified
crm_id
string
Maximum string length: 255
notes
string
frozen

Frozen status update flag.

change_commission_status
enum<string>

New status for the player's commissions (conversions) that are not in any invoice yet.

Available options:
approved,
pending,
rejected,
trash
commission_types
enum<string>[]

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.

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.

Available options:
cpa,
revshare,
cpl,
flat

Response

Player or trader updated.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
Example:

"User has been changed successfully!"