Search docs ⌘K
esc
Type to search across all documentation pages
Messaging

Conversations

Create, list, update, and manage conversations. Conversations can be archived, closed, or reopened through lifecycle transitions.

Create a conversation

POST
/modules/messaging/conversations
messaging:write

Create a new conversation.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/messaging/conversations \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 201 Created
{ "status": "ok" }
Body field
Type
Description
type
string
values: direct, groupdefault group
title
string
max 256 chars
description
string
max 2000 chars
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

List conversations

GET
/modules/messaging/conversations
messaging:read

List conversations.

curl
curl https://api.saasignal.saastemly.com/modules/messaging/conversations \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Query param
Type
Description
type
string
status
string
limit
integer
range ≥1 .. ≤100default 25
cursor
string
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Get a conversation

GET
/modules/messaging/conversations/{conversation_id}
messaging:read

Retrieve a single conversation.

curl
curl https://api.saasignal.saastemly.com/modules/messaging/conversations/{conversation_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
conversation_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Update a conversation

PATCH
/modules/messaging/conversations/{conversation_id}
messaging:write

Update a conversation.

curl
curl -X PATCH https://api.saasignal.saastemly.com/modules/messaging/conversations/{conversation_id} \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
conversation_id required
string
Body field
Type
Description
title
mixed
description
mixed
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Delete a conversation

DELETE
/modules/messaging/conversations/{conversation_id}
messaging:admin

Delete a conversation.

curl
curl -X DELETE https://api.saasignal.saastemly.com/modules/messaging/conversations/{conversation_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
conversation_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Archive a conversation

POST
/modules/messaging/conversations/{conversation_id}/archive
messaging:write

Archive a conversation.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/messaging/conversations/{conversation_id}/archive \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
conversation_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Close a conversation

POST
/modules/messaging/conversations/{conversation_id}/close
messaging:write

Close a conversation.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/messaging/conversations/{conversation_id}/close \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
conversation_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Reopen a conversation

POST
/modules/messaging/conversations/{conversation_id}/reopen
messaging:write

Reopen a closed or archived conversation.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/messaging/conversations/{conversation_id}/reopen \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
conversation_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited