POST /notes

Adds a new note.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
person_id Integer No

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) is specified.

project_id Integer No

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) is specified.

org_id Integer No

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) is specified.

pinned_to_lead_flag Number No

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

Possible values:

  • 0
  • 1
deal_id Integer No

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) is specified.

lead_id String No

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) is specified.

add_time String No

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

content String Yes

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

pinned_to_organization_flag Number No

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

Possible values:

  • 0
  • 1
pinned_to_person_flag Number No

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

Possible values:

  • 0
  • 1
pinned_to_deal_flag Number No

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

Possible values:

  • 0
  • 1
pinned_to_project_flag Number No

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

Possible values:

  • 0
  • 1
user_id Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.