Skip to main content
POST
Builder admin update auto referral

Headers

orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

orderly-account-id
string
required

Account ID of the authenticated account.

orderly-key
string
required

Public orderly key used to sign the request.

orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Body

application/json
required_trading_volume
number
required
max_rebate
number
required
referrer_rebate
number
required
referee_rebate
number
required
enable
boolean
required
description
string

All users who receive a ref code will see this description displayed in the admin tool.

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989