Create a mailbox note
Adds an internal note to a thread and returns it with status 201. Notes are visible to everyone on the mailbox and never sent.
POST
Adds an internal note to a thread and returns it with status 201. Notes are visible to everyone on the mailbox and never sent.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$threadId*stringMatch
^thread_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
body*stringcolor?string|null|nullpinned?boolean|nullSuccess
application/json- response
id*MailboxNoteIdMatch
^note_[0-9a-hjkmnp-tv-z]{16,24}$author*body*stringcolor*string|nullpinned*booleancreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.mailboxes.createNote({
"id": "example",
"threadId": "example",
"body": "example"
});Example Response
{
"id": "string",
"author": {
"kind": "user",
"id": "string",
"displayName": "string"
},
"body": "string",
"color": "string",
"pinned": true,
"createdAt": "string",
"updatedAt": "string"
}