Update thread properties
Change the properties of an existing thread
Overview #
Update an existing thread with new data.
await window.CordSDK.thread.updateThread('my-awesome-thread-id', {
name: 'A more awesome name',
resolved: true,
});Copy
What this function returns #
A promise that resolves to
true if the operation succeeded or rejects if it failed.Arguments this function takes #
The ID of the thread to update.
The data values that should be updated.
This is an object with the following fields:
Whether the thread is resolved. Setting this to
true is equivalent to setting resolvedTimestamp to the current time, and setting this to false is equivalent to setting resolvedTimestamp to null.The name of the thread. This is shown to users when the thread is referenced, such as in notifications. This should generally be something like the page title.
Arbitrary key-value pairs that can be used to store additional information.
A URL where the thread can be seen. This determines where a user is sent when they click on a reference to this thread, such as in a notification, or if they click on a reference to a message in the thread and the message doesn't have its own URL.
An optional space separated list of classnames to add to the thread.