DOdovetail
Notes

Patch note

Changed on

Update a data entry's (note's) properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.

Note: The notes resource has been renamed to data in Dovetail. New integrations should use Patch data (PATCH /v1/data/:data_id) instead.

Returns the updated note object.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: note:write

patch/v1/notes/{note_id}

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/notes/{note_id}
  • Auth
    HTTP bearer

Path parameters

note_idstring required

Unique identifier of the note.

Request body

titlestring

The note's title.

Example request

{
  "title": "My note"
}

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

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

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

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

    • breaking

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

    • warning

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