Update a Preference for a Participant

put/public/v1/preferences/{preference}

Fields left out of the request keep their current values. Send details as null to clear it.

put/public/v1/preferences/{preference}

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/preferences/{preference}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "level": "preferred",
  "type": "ethnicity",
  "value": "string",
  "details": "string"
}'

Response

{
  "data": {
    "id": "p1r2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "level": "required",
    "type": "gender",
    "value": "female",
    "details": "Prefers a female support worker for personal care",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_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

preferencestringrequired
The preference UUID

Body

application/json

levelenum<string>
Available options:preferredrequired
typeenum<string>
Available options:ethnicitygendermaximum_ageminimum_age
valuestringmax length 255
detailsstring | nullrequiredmax length 5000

Response

200application/json

ParticipantPreferenceResource

dataobjectrequired
▶Show 7 child attributesHide child attributes
- idstringrequired
  Example:p1r2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- levelstringrequired
  Example:required
- typestringrequired
  Example:gender
- valuestringrequired
  Example:female
- detailsstring | nullrequired
  Example:Prefers a female support worker for personal care
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_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