Skip to main content
POST
Create note

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_note.

object_type
enum<string>
required

Kind of the object: 'person', 'company', or 'workflow' for a sticker on its canvas. Must match the object_sid prefix (422 validation_failed otherwise).

Available options:
person,
company,
workflow
object_sid
string
required

The person (cr_pp_…), company (cr_co_…) or workflow (wf_wf_…) to pin the note to. Prefix must match object_type (422 validation_failed). Must be live and same-team (422 relation_not_found otherwise). Immutable after create.

Required string length: 18
body
string
required

Plain-text note body. Rendered as-is - no rich text, no attachments, no @-mentions. 1..65535 chars on a person or company; a sticker may be empty (""). On a sticker: two or three short sentences explaining a choice or a risk of that step.

Maximum string length: 65535
step_id
integer | null

A sticker only: the id of the workflow step it explains, from the workflow's saved steps (422 validation_failed for a step the workflow does not have). Omit for the sticker about the whole workflow. Never on a person or company note.

Required range: x >= 1
position
object | null

A sticker only, and set by the canvas when a person drags it: leave it out. Without it the canvas places the sticker beside its step.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required