PATCH
/v1/comms/conversations/{id}Star, pin or archive a conversation
Changes one thread's own flags — is_starred, is_pinned, is_archived — and corrects contact_name or contact_role, the name we show for the person on the other end. A field the body omits is left as it was. The ADDRESS cannot be changed: it is the thread's identity, and to reach another address you open its thread.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
Request body
application/jsonrequiredbodyoptional
paramsoptional
queryobjectoptional
Responses
200application/json
the action's answer
{
"account_identifier": "string",
"contact_identifier": "string",
"contact_name": "string",
"contact_role": "string",
"created_at": "string",
"id": 1,
"is_archived": true,
"is_muted": true,
"is_pinned": true,
"is_starred": true,
"last_message_at": "string",
"last_message_direction": "string",
"last_message_preview": "string",
"medium": "string",
"ownerAccountId": "",
"records": [
{
"definition_id": "",
"definition_key": "string",
"linked_at": "string",
"name": "string",
"row_id": "",
"status": "string",
"status_label": "string",
"status_tone": "string"
}
],
"subject": "string",
"unread_count": 1,
"visibility": "string"
}account_identifierstringoptional
contact_identifierstringoptional
contact_namestringoptional
contact_rolestringoptional
created_atstringoptional
idintegeroptional
is_archivedbooleanoptional
is_mutedbooleanoptional
is_pinnedbooleanoptional
is_starredbooleanoptional
last_message_atstringoptional
last_message_directionstringoptional
last_message_previewstringoptional
mediumstringoptional
ownerAccountIdstringoptional
recordsarray<>optional
subjectstringoptional
unread_countintegeroptional
visibilitystringoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired