notes

Create note

Add a plain-text note to exactly one person or company, or a sticker to a workflow canvas (object_type and object_sid must match, the object live in the team). A sticker explains the workflow to its readers: step_id names the step it sits beside (omit it for the whole workflow). No dedup: every call inserts a row. A person or company note writes a note_left activity; a sticker writes none. Not for structured attributes or message content.

Contract:

  • MCP tool create_note, registry package mcp.playtables/notes, mount playtables.pipeline.
  • Operation create, response envelope create.
  • Flags: none.
post/api/notes

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

object_type'person' | 'company' | 'workflow' 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).

object_sidstring 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.

bodystring 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.

step_idinteger nullable

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.

Response

create success envelope.

successtrue required
operation'create' required
already_existsboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.