curl --request POST \
--url https://api.heify.com/update-participant \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"participant_id": "2e2f776f-0dff-44a9-83e0-66ad34712623",
"tag": "chuchu caci",
"metadata": {
"department": "ventas"
}
}
'{
"data": {
"message": "Participant updated successfully",
"participant": {
"participant_id": "2e2f776f-0dff-44a9-83e0-66ad34712623",
"tag": "chuchu caci",
"metadata": {
"department": "ventas"
},
"created_at": "2026-03-21T13:33:23.189414+00:00",
"updated_at": "2026-03-21T13:38:48.510473+00:00"
}
}
}Participants
Update Participant
Update a participant’s tag and/or metadata.
POST
/
update-participant
curl --request POST \
--url https://api.heify.com/update-participant \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"participant_id": "2e2f776f-0dff-44a9-83e0-66ad34712623",
"tag": "chuchu caci",
"metadata": {
"department": "ventas"
}
}
'{
"data": {
"message": "Participant updated successfully",
"participant": {
"participant_id": "2e2f776f-0dff-44a9-83e0-66ad34712623",
"tag": "chuchu caci",
"metadata": {
"department": "ventas"
},
"created_at": "2026-03-21T13:33:23.189414+00:00",
"updated_at": "2026-03-21T13:38:48.510473+00:00"
}
}
}metadata uses full replacement semantics — the entire object is replaced by what you send. Any keys not included in the request will be lost. See Participant — metadata.tag and metadata are both optional. If neither is provided, the request still succeeds and only updated_at is refreshed.Returns
404 if the participant is not found.Authorizations
Body
application/json
The unique identifier of the participant to update.
New label for this participant. Max 100 characters. Cannot be empty or whitespace-only. Omit to leave unchanged.
Full replacement for the metadata object. All previous keys not included will be lost. Max 10 keys; key names max 50 characters; values max 250 characters. Omit to leave unchanged.
Response
200 - application/json
Participant updated successfully.
Show child attributes
Show child attributes