Skip to main content
PATCH
Update Contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required
contact_id
string<uuid>
required

Body

application/json

Partial update for an existing contact. Only fields explicitly set are written.

is_required is included as bool | None so unset means "leave alone"; pass false/true to flip it.

name
string | null
email
string | null
slack_user_id
string | null
slack_team_id
string | null
phone
string | null
job_title
string | null
department
string | null
seniority_level
integer | null
is_required
boolean | null

Response

Successful Response

id
string<uuid>
required
interview_id
string<uuid>
required
question_set_id
string<uuid> | null
required
name
string
required
email
string | null
required
phone
string | null
required
job_title
string | null
required
department
string | null
required
seniority_level
integer | null
required
is_required
boolean
required
meeting_url
string | null
required
status
string
required
scheduled_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
person_id
string<uuid> | null
slack_user_id
string | null
slack_team_id
string | null
slack_dm_channel_id
string | null
booking_token
string | null
reminder_count
integer
default:0
last_reminder_at
string<date-time> | null
reinvited_from_contact_id
string<uuid> | null
booking_token_expires_at
string<date-time> | null
invitation_status
string
default:none
scheduled_session_status
string | null
scheduled_session_available_at
string<date-time> | null
scheduled_session_started_at
string<date-time> | null
scheduled_session_expires_at
string<date-time> | null
delivery_failure_reason
string | null
delivery_failure_at
string<date-time> | null
last_accessed_at
string<date-time> | null
session_accessibility_message
string | null