Skip to main content
POST
Create a referral user

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new ReferralUser resource

referral
string<iri-reference>
Example:

"/api/v1/referrals/1"

user
string<iri-reference>
Example:

"/api/v1/users/1"

referralReason
string | null
answer1
string
answer2
string
answer3
string

Response

ReferralUser resource created

id
integer
read-only
referral
object
user
object
dateCreated
string<date-time>
read-only
referralReason
string | null
answer1
string
answer2
string
answer3
string