Update Referral Code

Updates the properties of an existing referral code, such as the maximum number of uses.

You can set max_uses to:

  • A positive integer (0 or greater) to limit the number of uses
  • null to allow unlimited uses

Required API Key Scope: service_role

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The referral code to update

Body Params
integer | null
≥ 0

Maximum number of times this code can be used. Set to null for unlimited uses, or 0 to disable the code.

Responses
204

No Content - Referral code successfully updated

400

Bad Request - Invalid max_uses value (must be 0 or greater, or null)

401

Unauthorized - Missing or invalid API key, or insufficient scope

404

Not Found - Referral code does not exist

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json