Skip to main content
PATCH
Update participant

Authorizations

x-api-key
string
header
required

API key with the iv_live_ prefix. Create one under Developer → API Keys.

Path Parameters

id
string<uuid>
required

id identifier

Body

application/json
name
string

Full name

email
string

Email address

external_id
string

Your ATS / system ID

phone
string

Phone number

tags
string[]

Replace tag list

status
string

active | archived

profile
object

{ title?, organization?, experienceLevel?, location? }

background
object

{ skills?, education?, languages? }

resume_url
string<uri>

Resume link

role_id
string<uuid>

Reassign to a different template

pipeline_id
string<uuid>

Move to a pipeline

metadata
object

Arbitrary key-value pairs

Response

Success

Last modified on July 20, 2026