Skip to main content

Create a note

Create a note inside a conversation.

Parameters​

content
string
required
Content of the note.
format
enum
required
The note format. One of text, html.

Returns​

Returns the created note object. Throws an error if some parameters are not valid.

post
/api/conversations/{id}/notes
curl -X POST https://{workspace}.kitchen.co/api/conversations/{id}/notes \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "author": "u_c01bb6102b6ddadd4b1f020e",
  "attachments": [
    "fi_081dcab571f6c37d709078ce"
  ],
  "content": "The note content",
  "conversation": "convr_1lbg89ha9ttb5dmxuldku3nx",
  "created_at": "2024-01-23T23:09:00+00:00",
  "format": "text",
  "id": "msg_3447589816730d8ba4e50528",
  "updated_at": "2024-01-23T23:09:00+00:00"
}