Skip to main content
POST
Send a recruit invite

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Body

application/json

Send a recruit invite to a candidate (creates a support channel + delivers a job-widget message, optional custom message, and optional interview-link widget). The acting company is the token tenant; a body companyId is ignored if it differs. Extra fields accepted but ignored (legacy-permissive passthrough).

candidateId
string
required

The candidate user id to invite.

jobId
string
required

The job id for the invitation.

message
string

Optional custom message to send with the invite. Supports the {interviewLink} placeholder, which triggers an interview-booking widget instead of inline text.

Optional custom job link URL used in the job widget.

Response

Invite-sent result with remaining invites and the created support channel id.

data
object
required