Skip to main content
POST
Archive conversation
Moves a conversation into the archived state without deleting messages. Use this when mirroring the “Archive” swipe/long-press action in the client. The response returns the updated conversation object (now status: "archived").

Authorizations

Authorization
string
header
required

Auth0 access token for registered users.

Path Parameters

conversationId
string
required

Conversation ID (24 character MongoDB ObjectId).

Required string length: 24

Response

Conversation archived.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required