Skip to main content
POST
Create a candidate scheduling link

Authorizations

Authorization
string
header
required

Company-scoped API key. Production keys are prefixed sk_live_, sandbox keys sk_test_, each followed by 22 base62 characters (pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration.

Path Parameters

bookingScheduleId
integer
required

Body

application/json

Creates (or, if an active link already exists for this entity on this schedule, returns) a unique self-scheduling link. Identify the entity to book on behalf of with entityType + entityId; TapTalent resolves the record and snapshots its contact details onto the resulting link — you don't provide name/email/phone yourself. The entity must already exist (e.g. an existing job candidate, sourced via the Job Candidates API); this endpoint doesn't create new candidate records.

entityType
string
required

Not a fixed enum — known values today are JOB_CANDIDATE (entityId is a jobCandidateId from the Jobs/Candidates APIs), OUTREACH_CAMPAIGN_CANDIDATE, and NOVA_CANDIDATE. Only JOB_CANDIDATE ids are obtainable through this API — the other two types are sourced entirely from TapTalent's own campaign/onboarding flows and have no corresponding lookup here.

Example:

"JOB_CANDIDATE"

entityId
string
required

The id of the entity within entityType's source. Always a string.

Example:

"55021"

expiresInHours
integer

How long the generated link stays valid. Defaults to the schedule's own expiry behavior if omitted.

Example:

168

Response

Booking link created or reused.

status
string
required
Allowed value: "success"
data
object
required