curl --request PATCH \
--url https://api.talkpilot.io/v1/agents/{agentId}/employees/{employeeId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "urlaub"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone_number": "<string>",
"email": "jsmith@example.com",
"status": "anwesend",
"active": true,
"get_mail": true,
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"back_at_work_at": "2023-12-25",
"notdienst_bereiche": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Update an employee
Partially update an employee. Common use case: changing the status (e.g., marking an employee as on vacation).
curl --request PATCH \
--url https://api.talkpilot.io/v1/agents/{agentId}/employees/{employeeId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "urlaub"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone_number": "<string>",
"email": "jsmith@example.com",
"status": "anwesend",
"active": true,
"get_mail": true,
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"back_at_work_at": "2023-12-25",
"notdienst_bereiche": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
API key for external access. Format: tp_live_<32-hex-chars>.
Create keys in the TalkPilot Dashboard under Settings > API.
Body
Partial employee update.
1 - 25530Employee availability status:
anwesend— Present / availableurlaub— On vacationkrank— Sick leaveweiterbildung— In trainingnotdienst— Emergency dutyim_termin— In a meetingausser_haus— Out of office
anwesend, urlaub, krank, weiterbildung, notdienst, im_termin, ausser_haus Only kept while status is notdienst; a status change away from it clears the areas. Trimmed and de-duplicated; empty array becomes null. At least one area is required while status is notdienst if the organization has more than one notdienst_bereiche entry
Response
Updated employee
Employee availability status:
anwesend— Present / availableurlaub— On vacationkrank— Sick leaveweiterbildung— In trainingnotdienst— Emergency dutyim_termin— In a meetingausser_haus— Out of office
anwesend, urlaub, krank, weiterbildung, notdienst, im_termin, ausser_haus Whether the employee receives email notifications
Expected return date (YYYY-MM-DD) while absent
Emergency-duty areas of the current shift (from the organization's notdienst_bereiche; one employee can cover several). Cleared automatically when the status leaves notdienst