Skip to main content
POST
/
v1
/
referral
/
auto_referral
/
update
Builder admin update auto referral
curl --request POST \
  --url https://api.orderly.org/v1/referral/auto_referral/update \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "required_trading_volume": 123,
  "max_rebate": 123,
  "referrer_rebate": 123,
  "referee_rebate": 123,
  "enable": true,
  "description": "<string>"
}
'
{
  "success": true,
  "timestamp": 1702989203989
}

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