Skip to content
Sencai Logo Sencai Logo Sencai Docs

Create a referral-link

POST
/referral-links

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
data
object
code
required
string
reward_type
string
Allowed values: credit discount trial_extension
reward_value
number
reward_currency
string
uses_count
integer
max_uses
integer
active
boolean
expires_at
string format: date-time
creator_org
One of:

DocumentId reference to api::organisation.organisation

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Created

object
data
object
code
required
string
reward_type
string
Allowed values: credit discount trial_extension
reward_value
number
reward_currency
string
uses_count
integer
max_uses
integer
active
boolean
expires_at
string format: date-time
creator_org
One of:

DocumentId reference to api::organisation.organisation

string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

400

Section titled “400 ”

Validation error

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

Not authorized (tenant scope or capability)