v1

latestOpenAPI 3.0.12026-08-0621301.7 MB

Notes

Add a note

Adds a new note.

post/notes

Request body

contentstring required

The content of the note in HTML format. Subject to sanitization on the back-end.

lead_idstring uuid

The ID of the lead the note will be attached to. This property is required unless one of (deal_id/person_id/org_id/project_id/task_id) is specified.

deal_idinteger

The ID of the deal the note will be attached to. This property is required unless one of (lead_id/person_id/org_id/project_id/task_id) is specified.

person_idinteger

The ID of the person this note will be attached to. This property is required unless one of (deal_id/lead_id/org_id/project_id/task_id) is specified.

org_idinteger

The ID of the organization this note will be attached to. This property is required unless one of (deal_id/lead_id/person_id/project_id/task_id) is specified.

project_idinteger

The ID of the project the note will be attached to. This property is required unless one of (deal_id/lead_id/person_id/org_id/task_id) is specified.

task_idinteger

The ID of the task the note will be attached to. This property is required unless one of (deal_id/lead_id/person_id/org_id/project_id) is specified.

user_idinteger

The ID of the user who will be marked as the author of the note. Only an admin can change the author.

add_timestring

The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS

pinned_to_lead_flag0 | 1

If set, the results are filtered by note to lead pinning state (lead_id is also required)

pinned_to_deal_flag0 | 1

If set, the results are filtered by note to deal pinning state (deal_id is also required)

pinned_to_organization_flag0 | 1

If set, the results are filtered by note to organization pinning state (org_id is also required)

pinned_to_person_flag0 | 1

If set, the results are filtered by note to person pinning state (person_id is also required)

pinned_to_project_flag0 | 1

If set, the results are filtered by note to project pinning state (project_id is also required)

pinned_to_task_flag0 | 1

If set, the results are filtered by note to task pinning state (task_id is also required)

Response

Add, update or get a note

successboolean

If the request was successful or not