Skip to main content
POST

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

Records a booking directly for a slot, location, and set of answers already collected on your side — no self-scheduling link involved. Works for INTERVIEW- and EVENT-profile schedules alike.

entityType
string
required

See Booking.entityType.

Example:

"JOB_CANDIDATE"

entityId
string
required

See Booking.entityId.

Example:

"55021"

scheduledStartAt
string<date-time>
required

Must match one of the schedule's currently available slots — see GET /booking-schedules/{bookingScheduleId}/slots.

selectedFormat
enum<string> | null

Required for a BOTH-mode schedule; omitted otherwise.

Available options:
ONLINE,
ONSITE
Example:

"ONSITE"

selectedLocationId
integer

Required for an EVENT-profile schedule — the id of one of its GET /booking-schedules/{bookingScheduleId}/locations results. Omitted for INTERVIEW-profile schedules.

bookingAnswers
object

Required for an EVENT-profile schedule — answers keyed by each question's id from GET /booking-schedules/{bookingScheduleId}/questions. Each value's shape follows that question's type — a string for text/textarea/phone/single_choice, an array of strings for multi_choice. Omitted for INTERVIEW-profile schedules.

Response

Booking created.

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

A single scheduled appointment, created when a candidate books a slot on a booking link.