Skip to main content
POST
Crear una nota
Creates a note. Besides content, you must attach the note to something: at least one of chat_user or ticket_id is required. Sending neither returns 400. The company, project, and the note’s author are taken from your token and must not appear in the body. Sending them returns 400.
The author is recorded as the user who owns the token. If several systems write notes, mint one token per system so the timeline shows who wrote what.

Endpoint

Required scope

crm:notes:write

Headers

Body

Example request

Response

201 Created

400 Bad Request

Missing or empty content, neither chat_user nor ticket_id, content longer than 5000 characters, a malformed ObjectId, a type outside the allowed set, or a property the endpoint does not accept — including company, project, and created_by, which are derived from the token.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the crm:notes:write scope.

Operational notes

  • Referenced ids are not verified. A ticket_id pointing at a ticket that does not exist is stored as-is, and the note simply never appears on a timeline. Create the ticket first.
  • Use type deliberately. call, email, and meeting render as interaction entries in the portal; note renders as a plain comment.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Body

application/json
content
string
required

Contenido de la nota

chat_user
string

Chat user (contacto) al que refiere

ticket_id
string

Ticket al que se adjunta la nota

type
enum<string>
default:note
Available options:
note,
call,
email,
meeting

Response

201 - application/json
note
object
required