Skip to main content
Register a recruiter of the organization

Authorizations

x-partner-key
string
header
required

Partner API key: vpk_live_ + 48 lowercase hex. Server-side only.

x-vort-org
string
header
required

Customer org token: vot_ + 48 lowercase hex, from /activations/redeem. Server-side only.

Headers

x-vort-lang
enum<string>

Language of notices and messages. Defaults to the partner default.

Available options:
he,
en

Body

application/json
external_id
string
required
Minimum string length: 1
email
string<email>
required

The recruiter's work e-mail, stored as their contact / display e-mail only. Not a login: no Vort account is created or linked under this address.

full_name
string
required

Shown as the recruiter's display name in Vort.

role
string
required

The user's role in your product (e.g. recruiter, admin). Informational in v1.

Response

Registered (created is false when the external_id was already registered).

user_id
string<uuid>
required
created
boolean
required