Skip to navigation

Create note

Create a note. Plan manager scope from X-Plan-Manager-Id header. Set participant to attach the note to a participant.

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Request

This endpoint expects an object.
titlestringOptional
descriptionstringOptional
authorstringOptional
Author user id
participantstringOptionalformat: "uuid"
note_typestringOptional

Note type label (align with /note-types entries)

prioritybooleanOptional
note_datedateOptional
providerstringOptionalformat: "uuid"
invoiceintegerOptional
external_idstringOptional
pinnedbooleanOptional

Response

Note created
idstringOptional

Note id (bigint as string)

created_atdatetimeOptional
titlestringOptional
descriptionstringOptional
authorstringOptional
plan_managerstringOptionalformat: "uuid"
participantstringOptionalformat: "uuid"
note_typestringOptional
prioritybooleanOptional
note_datedateOptional
providerstringOptionalformat: "uuid"
invoicestringOptional

Associated invoice id (bigint as string)

external_idstringOptional
pinnedbooleanOptional
audit_logmap from strings to anyOptional

Audit log entries (read-only

count_attachmentsintegerOptional

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error