Back to Pipedrive OauthUpdate a note
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: integer
description: The ID of the note
required:
- id
data:
title: noteRequest
type: object
properties:
content:
type: string
description: >-
The content of the note in HTML format. Subject to sanitization on the
back-end.
lead_id:
type: string
format: uuid
description: The ID of the lead the note will be attached to
deal_id:
type: integer
description: The ID of the deal the note will be attached to
person_id:
type: integer
description: The ID of the person the note will be attached to
org_id:
type: integer
description: The ID of the organization the note will be attached to
user_id:
type: integer
description: >-
The ID of the user who will be marked as the author of the note. Only
an admin can change the author.
add_time:
type: string
description: >-
The optional creation date & time of the note in UTC. Can be set in
the past or in the future. Requires admin user API token. Format:
YYYY-MM-DD HH:MM:SS
pinned_to_lead_flag:
description: >-
If set, the results are filtered by note to lead pinning state
(`lead_id` is also required)
title: numberBoolean
type: number
enum:
- 0
- 1
pinned_to_deal_flag:
description: >-
If set, the results are filtered by note to deal pinning state
(`deal_id` is also required)
title: numberBoolean
type: number
enum:
- 0
- 1
pinned_to_organization_flag:
description: >-
If set, the results are filtered by note to organization pinning state
(`org_id` is also required)
title: numberBoolean
type: number
enum:
- 0
- 1
pinned_to_person_flag:
description: >-
If set, the results are filtered by note to person pinning state
(`person_id` is also required)
title: numberBoolean
type: number
enum:
- 0
- 1
Output
title: oneNoteResponse200
type: object
properties:
success:
type: boolean
description: If the request was successful or not
data:
type: object
properties:
id:
type: integer
description: The ID of the note
active_flag:
type: boolean
description: Whether the note is active or deleted
add_time:
type: string
description: The creation date and time of the note
content:
type: string
description: >-
The content of the note in HTML format. Subject to sanitization on the
back-end.
deal:
type: object
description: The deal this note is attached to
properties:
title:
type: string
description: The title of the deal this note is attached to
lead_id:
type: string
format: uuid
description: The ID of the lead the note is attached to
deal_id:
type: integer
description: The ID of the deal the note is attached to
last_update_user_id:
type: integer
description: The ID of the user who last updated the note
org_id:
type: integer
description: The ID of the organization the note is attached to
organization:
type: object
description: The organization the note is attached to
properties:
name:
type: string
description: The name of the organization the note is attached to
person:
type: object
description: The person the note is attached to
properties:
name:
type: string
description: The name of the person the note is attached to
person_id:
type: integer
description: The ID of the person the note is attached to
pinned_to_deal_flag:
type: boolean
description: If true, the results are filtered by note to deal pinning state
pinned_to_organization_flag:
type: boolean
description: >-
If true, the results are filtered by note to organization pinning
state
pinned_to_person_flag:
type: boolean
description: If true, the results are filtered by note to person pinning state
update_time:
type: string
description: The last updated date and time of the note
user:
type: object
description: The user who created the note
properties:
email:
type: string
description: The email of the note creator
icon_url:
type: string
description: The URL of the note creator avatar picture
is_you:
type: boolean
description: Whether the note is created by you or not
name:
type: string
description: The name of the note creator
user_id:
type: integer
description: The ID of the note creator