Update a Participant Information Item

put/public/v1/participant-information-items/{participantInformationItem}

put/public/v1/participant-information-items/{participantInformationItem}

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/participant-information-items/{participantInformationItem}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "required": true,
  "documents_allowed": true,
  "visible_to_support_workers": true,
  "order": 0
}'

Response

{
  "data": {
    "id": "i1t2e3m4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
    "name": "Emergency Contact",
    "required": true,
    "order": 1,
    "documents_allowed": true,
    "visible_to_support_workers": false,
    "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

participantInformationItemstringrequired
The participant information item UUID

Body

application/json

namestringmax length 255
requiredboolean
documents_allowedboolean
visible_to_support_workersboolean
orderinteger≥ 0

Response

200application/json

App.PublicApi.V1.ParticipantInformationItems.ParticipantInformationItemResource

dataobjectrequired
▶Show 7 child attributesHide child attributes
- idstringrequired
  Example:i1t2e3m4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestringrequired
  Example:Emergency Contact
- requiredbooleanrequired
  Example:true
- orderintegerrequired
  Example:1
- documents_allowedbooleanrequired
  Example:true
- visible_to_support_workersbooleanrequired
  Example:false
- 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