Inboxes
Add an internal comment to a thread
Adds an internal (team-only) comment to the thread, as the acting user, the same as commenting in the app. It is never sent to the contact. content is HTML and is sanitized. Mention markup in it labels the thread for the mentioned users and teams, marks it unread for them and notifies them. Mentioned contacts and location cards are related to the thread.
The acting user is the delegate token's own user. With an API key or partner token, name one in userId. Guests cannot comment.
post/api/inboxes/{channelId}/threads/{threadId}/comments
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
channelIdstring required
External channel meta ID (meta.id) of the inbox.
threadIdstring required
Thread id from the threads list.
Request body
Response
Comment added.
Changes
No recorded changes to this operation across all 1 revision of this API.