Skip to main content
GuidesAPI Reference

Update Note

PUT 
/crm/notes/:noteId

Update note

Request​

Path Parameters

    noteId stringrequired

    The item id of the note record

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    noteContent string

    The main text or content of the note.

    noteTitle string

    The title of the note.

    noteContact string

    The name or identifier of the contact associated with the note. Required if noteAccount not specified.

    noteAccount string

    The name or identifier of the account that the note is related to. Required if noteContact not specified.

    noteOwner string

    The name or identifier of the individual or team responsible for creating or managing the note.

    noteOpportunity string

    The name or identifier of the sales opportunity linked to the note.

    remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    note

    object

    remoteId string
    noteOwner string
    noteTitle
    noteContent string
    noteContact string
    noteAccount
    noteOpportunity
    id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...