Skip to main content
POST
Edit referral description

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
user_address
string
required

User address of an existing referral-code holder under the Builder.

description
string | null

Private description for the referral-code holder. Set to null to clear it.

Maximum string length: 50
Pattern: ^[A-Za-z0-9_@, -]{0,50}$

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989

data
object | null
Example:

null