ClientsEdit a note

Edit a note

Needs: Clients Read, and Read-write on Clients or Tasks

Edits a General or Task note. Send only what changes. Appointment notes are not edited here.

Errors

  • 422 with ref must be a general or task note ref when the ref is not general:ID or task:ID.
  • 404 when the note is not found.
curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/client-notes/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "notes": "<p>Updated: visit confirmed for Monday 9am.</p>"
}'
{}
PATCH
/client-notes/{ref}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
path
refstring
Required

A note ref from the notes list, such as general:12 or task:34.

Content-Typestring
Required

The media type of the request body

Options: application/json
notesstring

The new note text.

titlestring

Task notes only.

appointment_refstring

General notes only. Link a single-client shift such as a:123, or send null to unlink.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Path Parameters

refstring
Required

A note ref from the notes list, such as general:12 or task:34.

Body

application/json
notesstring

The new note text.

titlestring

Task notes only.

appointment_refstring

General notes only. Link a single-client shift such as a:123, or send null to unlink.

Responses

OK