Skip to content

Message Thread

Representation of a message thread which can be used for general chat or discussions associated with other concepts.

Browse the docs

Endpoints

GET/n/v1/messagethread/{urn}
Message Thread endpoint allows integrations to create a chat thread with messages for discussion. They are message threads rather than chat threads because they are used for purposes beyond regular SMS style message threads. Message threads can be associated with almost any of the core concepts on the platform, e.g. a task discussion, a group for members to discuss subjects or the history of an invoice. Message threads for chats don't need to be associated with other concepts for example if using them for customer chat on your website for generating leads, you can create an anonymous identity for the session user and assign one of your sales team as a member of the group for notifications.
Parameters
urn (path, required)
String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
200 OK
returns Message ThreadREAD_SUCCESS
404 Not found
returns ErrorNOT_FOUND
```
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
  https://api.baack.co/n/v1/messagethread/{urn}
```

Fields

Message Thread fields
Field	Type	Description
urn	string (uuid)
companies	array of Company	Ignored on update.
projects	array of Project	Ignored on update.
pagination	Pagination
invoices	array of Payment Invoice	Ignored on update.
purpose	string	One of: `GENERAL`, `CHANGELOG`, `BAACK_CUSTOMER_SUPPORT`, `SUPPORT`, `PROJECT_DISCUSSION`, `TASK_DISCUSSION`, `COMPANY_DISCUSSION`, `PAYMENT_INVOICE_DISCUSSION`, `ENTITY_DISCUSSION`
entities	array of Entity	Ignored on update.
name	string
posts	array of Thread post	Ignored on update.
url	string (uri)
tasks	array of Task	Ignored on update.
group	Group	Required on create.Ignored on update.

Used by: Message Thread Notification, Thread post