Skip to main content
POST
Create a partner referral request

Autorizaciones

Authorization
string
header
requerido

An Account API key or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

partner:referral_request:create

Encabezados

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Ejemplo:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Cuerpo

application/json
account_id
string
requerido

Business to request attribution for, prefixed biz_.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

authorized_user_id
string

Your team membership on the business this referral is made for, prefixed ausr_. Omit for a personal referral.

member_id
string

Your member record on the business this referral is made for, prefixed mber_, when your role there is held on your member record. Send this or authorized_user_id, not both.

Respuesta

Existing request or referral link returned.

account
object | null
requerido

Business receiving the request, when one is assigned.

authorized_user_id
string | null
requerido

The partner's team membership this referral was created for, prefixed ausr_. null when the referral is personal.

Ejemplo:

null

code
string | null
requerido

Unique referral code, when assigned.

Ejemplo:

null

created_at
string
requerido

When the request was created, as an ISO 8601 timestamp.

Ejemplo:

"2026-01-01T12:00:00.000Z"

id
string
requerido

Partner referral request ID, prefixed prfr_.

Ejemplo:

"prfr_xxxxxxxxxxxxxx"

max_redemptions
integer | null
requerido

Maximum permitted redemptions, when limited.

Ejemplo:

null

member_id
string | null
requerido

The partner's member record this referral was created for, prefixed mber_, when their role on that business is held on their member record. null otherwise.

Ejemplo:

null

partner
object
requerido

Public profile of the requesting partner.

referring_account
object | null
requerido

Business the partner sent this request on behalf of, when the referral belongs to their team. null for a personal referral.

request_type
enum<string>
requerido

How the referral request was initiated.

Opciones disponibles:
manual,
ownership_transfer,
link
Ejemplo:

"manual"

rewards
object[]
requerido
status
enum<string> | null
requerido

The approval state, or null for requests without an approval process.

Opciones disponibles:
pending,
accepted,
denied,
cancelled,
null
Ejemplo:

"accepted"

updated_at
string
requerido

When the request last changed, as an ISO 8601 timestamp.

Ejemplo:

"2026-01-01T12:00:00.000Z"

user
object | null
requerido
obsoleto

The user an attribution request was sent to. Deprecated: requests to a user have ended. Always null. DEPRECATED: No longer populated. Always null.