Skip to main content
POST
Update a thread

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Body

application/json
assignee
string | null

The user id to assign this thread to, or null to unassign.

status
enum<string>

Whether the thread is open or closed.

Available options:
open,
closed

Response

200 - application/json

Returns the updated thread object.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
thread
assignee
string | null
required

The user this thread is assigned to, if any.

channel
enum<string>
required

The communication channel for this thread. email today; additional channels may be added later.

Available options:
email
counterparty
string
required

The other party’s address on this channel (email address today, phone number later).

customer
required

The matched customer, if the counterparty resolved to one.

last_message_at
integer | null
required

When the most recent message was sent or received.

owner
required

The matched owner, if the counterparty resolved to one.

status
enum<string>
required

Whether the thread is open or closed.

Available options:
open,
closed
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

email
object

Email-specific fields. Present when channel is email.

metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

timeline_entries
object

The first page of timeline entries, newest first. Omitted unless include[]=timeline_entries.