Skip to main content
POST
Create a partner

Authorizations

Authorization
string
header
required

API key issued by VitaRelay. Send as Authorization: Bearer vr_live_… (production) or Authorization: Bearer vr_test_… (sandbox).

Body

application/json
external_id
string
required

Your identifier for this partner. Acts as an idempotency key.

name
string
required
email
string<email>
required
phone
string
sponsor_external_id
string

The external_id of this partner's sponsor, if any. Must already exist.

send_invite
boolean
default:true

Email the partner a portal invitation.

Response

Idempotent replay of an existing external_id.

data
object
Example: