PATCH/v1/messages/{threadId}

Update a message thread

Updates an existing message thread. Supply status, subject, or both to change the corresponding thread fields. If provided, status must be open or closed.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
threadIdstringrequired
The unique identifier of the thread to update.

The message thread fields to update.

statusstringoptional
The thread status: `open` or `closed`.
Allowed:openclosed
subjectstringoptional
The subject of the message thread.

3 status codes
200Returns the updated thread in the `data` field.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional
404Returned when the thread does not exist.
errorobjectoptional

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the threadId path parameter does not identify an existing thread. status must be open or closed when provided.