Update a Note Template

put/public/v1/note-templates/{noteTemplate}

put/public/v1/note-templates/{noteTemplate}

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/note-templates/{noteTemplate}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "content": "string",
  "usage": "bulk_participant_message_email"
}'

Response

{
  "data": {
    "id": "n1o2t3e4-t5e6-47m8-9p0l-1b2c3d4e5f6g",
    "name": "Initial Assessment",
    "content": "<p>Assessment notes for the participant.</p>",
    "usage": "participant_notes",
    "created_at": "2024-01-15T10:30:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

noteTemplatestringrequired
The note template UUID

Body

application/json

namestringmax length 50
contentstringmax length 65535
Limited to 65535 bytes.
usageenum<string> | null
Available options:bulk_participant_message_emailbulk_participant_schedule_emailcalendar_eventscharge_detailschat_messagecomplaint_detailscomplaint_follow_upfeedback_detailsfeedback_follow_upform_submission_requestincident_detailsincident_follow_upparticipant_alertsparticipant_budget_descriptionparticipant_budget_itemparticipant_goalsparticipant_information_itemsparticipant_notesparticipant_recordsparticipant_risk_descriptionparticipant_schedule_emailplan_implementationreferral_detailsshift_detailssignature_requestsite_information_itemssupport_admin_detailssupport_detailssupport_notestask_notesuser_biouser_notesvoided_invoice_notificationvoided_invoice_reason

Response

200application/json

NoteTemplateResource

dataobjectrequired
▶Show 5 child attributesHide child attributes
- idstringrequired
  Example:n1o2t3e4-t5e6-47m8-9p0l-1b2c3d4e5f6g
- namestringrequired
  Example:Initial Assessment
- contentstringrequired
  Example:<p>Assessment notes for the participant.</p>
- usagestring | nullrequired
  Example:participant_notes
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors