Add note
Add an internal note to a conversation.
POST https://cotlet.dev/api/v1/help-scout/conversations/{conversation_id}/notes
write
Adds a note as the Note editor does. A note is never sent to the customer and any Help Scout user can add one to any conversation. Mention teammates with @name to bring them in. Help Scout offers no draft for a note, so it is saved at once. It reaches no customer, so it does not ask for your OK.
Parameters
| Name | Type | Description |
|---|---|---|
| conversation_id integer required | integer | Conversation number from search_conversations. |
| text string required | string | Note body. Use @name to mention a teammate. |
Request
curl -X POST https://cotlet.dev/api/v1/help-scout/conversations/1/notes \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"text"}'result = client.call("help-scout", "add_note", {"conversation_id":1,"text":"text"})const result = await cotlet.call('help-scout', 'add_note', {"conversation_id":1,"text":"text"});cotlet call help-scout add_note --data '{"conversation_id":1,"text":"text"}'Example response
{
"conversation_id": 48244,
"thread_id": 903340,
"type": "note",
"mentions": [
"Maria Silva"
]
}