Skip to main content
POST
Create an invite

Authorizations

Authorization
string
header
required

VitaRelay API key (vr_live_... or vr_test_...) with the invites:* scopes.

Body

application/json
type
enum<string>
default:clinic

clinic for a Tele Clinic, rep for a Rep Partner.

Available options:
clinic,
rep
email
string<email>

Required unless send_email is false. The invite email is sent here.

phone
string
first_name
string
last_name
string
product_types
enum<string>[]

Which product groups the invited organization can see. Omit for all. 503B is never offered.

Available options:
503a,
rnd,
supplements
send_email
boolean
default:true

Set false to get the link back without emailing the prospect.

external_invite_id
string

Your own id for the invite. Makes the call safe to retry.

Maximum string length: 128

Response

Replay of an earlier call with the same external_invite_id; the original invite.

data
object