Atlas
Conversations

Star or unstar a conversation

Sets the starred status of a conversation.

PATCH
/api/v1/conversations/{id}/star

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

starred*boolean

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3001/api/v1/conversations/550e8400-e29b-41d4-a716-446655440000/star" \  -H "Content-Type: application/json" \  -d '{    "starred": true  }'
{
  "id": "string",
  "starred": true
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}