Add a Note to a Participant

post/public/v1/participants/{participant}/notes

post/public/v1/participants/{participant}/notes

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/notes' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "string",
  "checkin_type": "email",
  "author": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
  }
}'

Response

{
  "data": {
    "id": "n1o2t3e4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
    "content": "Supported the participant with their morning routine.",
    "source_type": "support",
    "source": {
      "id": "string",
      "type": "string"
    },
    "author": {
      "id": "u1s2e3r4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
      "name": "Jane Smith"
    },
    "checkin_type": "phone",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_at": "2024-01-15T11:05: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

participantstringrequired
The participant UUID

Body

application/json

contentstringrequiredmax length 16777215
Limited to 16777215 bytes.
checkin_typeenum<string> | null
Available options:emailface to facephonesmsteleconsult
authorobject
▶Show 1 child attributesHide child attributes
- idstring<uuid>

Response

200application/json

ParticipantNoteResource

dataobjectrequired
▶Show 8 child attributesHide child attributes
- idstringrequired
  Example:n1o2t3e4-b5c6-47d8-9e0f-1a2b3c4d5e6f
- contentstringrequired
  Example:Supported the participant with their morning routine.
- source_typestringrequired
  Example:support
- sourceobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  typestring | nullrequired
- authorobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-b5c6-47d8-9e0f-1a2b3c4d5e6f
  namestringrequired
  Example:Jane Smith
- checkin_typestring | nullrequired
  Example:phone
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstringrequired
  Example:2024-01-15T11:05:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors