Skip to main content
POST
Create referral

Authorizations

Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Body

application/json
email
string<email>
required

Email of the referral

promoter_campaign_id
integer
required

The ID of the promoter campaign

uid
string

Unique ID of the referral

Response

Successful response

id
integer
uid
string
state
enum<string>
Available options:
subscribed,
signup,
active,
cancelled,
refunded,
denied,
pending,
moved
metadata
object
created_at
string<date-time>
customer_since
string<date-time>
email
string<email>
promoter_campaign
object