PIpipedrive
Notes

Update a note

Changed on

Updates a note.

put/notes/{id}

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: deals:full, contacts:full

Path parameters

idinteger required

The ID of the note

Request body

contentstring

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

deal_idinteger

The ID of the deal the note will be attached to

person_idinteger

The ID of the person the note will be attached to

org_idinteger

The ID of the organization the note will be attached to

project_idinteger

The ID of the project the note will be attached to

task_idinteger

The ID of the task the note will be attached to

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

Changes

  • 7268bbc4a587Revision changes
    • info

      added the optional property // to the response with the status

    • info

      removed subschema #1 from the / response property allOf list for the response status

  • 486265e92db9Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #1 to the / response property allOf list for the response status