PATCH/v1/messages/{threadId}

Update a message thread

Updates an existing message thread. Supply status or subject to change the corresponding thread field; both fields are optional. Use threadId to identify the thread to update.

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

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

Fields to update on the message thread; both listed fields are optional.

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

3 status codes
200Returns the updated thread in the `data` object.
dataobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional
404Returned when no thread exists with the given `threadId`.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. A 404 is returned when no thread exists with the given threadId path parameter. If provided, status must be open or closed.