Update a Participant

put/public/v1/participants/{participant}

put/public/v1/participants/{participant}

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "preferred_name": "string",
  "pronouns": "string",
  "gender": "female",
  "sex": "another_term",
  "language": "string",
  "ethnicity": "string",
  "ndis_number": 1.5,
  "medicare": "string",
  "external_id": "string",
  "mobile": "string",
  "primary_diagnosis": "string",
  "secondary_diagnosis": "string",
  "email": "jane.citizen@example.com",
  "dob": "2026-07-01",
  "commencement_date": "string",
  "is_ndis_number_exempt": true
}'

Response

{
  "data": {
    "id": "p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
    "initials": "JD",
    "full_name": "John Doe",
    "first_name": "John",
    "middle_name": "Michael",
    "last_name": "Doe",
    "preferred_name": "Johnny",
    "dob": "1990-05-15",
    "phone": "02 9876 5432",
    "mobile": "0412 345 678",
    "email": "john.doe@example.com",
    "status": "active",
    "primary_diagnosis": "Autism Spectrum Disorder",
    "secondary_diagnosis": "Intellectual Disability",
    "pronouns": "he/him",
    "gender": "male",
    "sex": "female",
    "language": "English",
    "ethnicity": "Australian",
    "ndis_number": "412345678",
    "external_id": "external-reference-123",
    "medicare": "4123 45678 9",
    "centrelink": "1234 567 890A",
    "invoice_email": "accounts@example.com",
    "commencement_date": "2024-01-01T00:00:00+00:00",
    "exit_date": "2025-01-01T00:00:00+00:00",
    "exit_reason": "Moved interstate",
    "exit_details": "Moved interstate",
    "is_ndis_number_exempt": false,
    "preferred_contact_method": "email",
    "created_at": "2024-01-15T10:30:00+00:00",
    "checkin_period": 30,
    "tags": [
      {
        "id": "p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
        "name": "High Priority",
        "colour": "#FF0000"
      }
    ],
    "primary_coordinator": {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com"
    },
    "plan_manager": {
      "id": "p1m2a3n4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "name": "Astalty Plan Management",
      "invoice_email": "invoices@astalty.com.au"
    },
    "alerts": [
      {
        "id": "p1a2l3e4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
        "title": "Medication",
        "content": "Requires medication at midday",
        "type": "warning",
        "visible_to_support_workers": true,
        "visible_when_scheduling": true,
        "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

participantstringrequired
The participant UUID

Body

application/json

first_namestringmax length 255
middle_namestring | nullmax length 255
last_namestringmax length 255
preferred_namestring | nullmax length 255
pronounsstring | nullmax length 255
genderenum<string> | null
Available options:femalemalenon_binaryotherprefer_not_to_say
sexenum<string> | null
Available options:another_termfemalemale
languagestring | nullmax length 255
ethnicitystring | nullmax length 255
ndis_numbernumber | null
medicarestring | nullmax length 255
external_idstring | nullmax length 255
mobilestring | null
primary_diagnosisstring | nullmax length 255
secondary_diagnosisstring | nullmax length 255
emailstring<email> | nullmax length 255
dobstring<date> | null
commencement_datestring | null
is_ndis_number_exemptboolean

Response

200application/json

ParticipantResource

dataobjectrequired
▶Show 36 child attributesHide child attributes
- idstringrequired
  Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
- initialsstringrequired
  Example:JD
- full_namestringrequired
  Example:John Doe
- first_namestringrequired
  Example:John
- middle_namestring | nullrequired
  Example:Michael
- last_namestring | nullrequired
  Example:Doe
- preferred_namestring | nullrequired
  Example:Johnny
- dobstring | nullrequired
  Example:1990-05-15
- phonestring | nullrequired
  Example:02 9876 5432
- mobilestring | nullrequired
  Example:0412 345 678
- emailstring | nullrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activearchived
- primary_diagnosisstring | nullrequired
  Example:Autism Spectrum Disorder
- secondary_diagnosisstring | nullrequired
  Example:Intellectual Disability
- pronounsstring | nullrequired
  Example:he/him
- genderstring | nullrequired
  Example:male
- sexstring | nullrequired
  Example:female
- languagestring | nullrequired
  Example:English
- ethnicitystring | nullrequired
  Example:Australian
- ndis_numberstring | nullrequired
  Example:412345678
- external_idstring | nullrequired
  Example:external-reference-123
- medicarestring | nullrequired
  Example:4123 45678 9
- centrelinkstring | nullrequired
  Example:1234 567 890A
- invoice_emailstring | nullrequired
  Example:accounts@example.com
- commencement_datestring | nullrequired
  Example:2024-01-01T00:00:00+00:00
- exit_datestring | nullrequired
  Example:2025-01-01T00:00:00+00:00
- exit_reasonstring | nullrequired
  Example:Moved interstate
- exit_detailsstring | nullrequired
  Example:Moved interstate
- is_ndis_number_exemptbooleanrequired
  Example:false
- preferred_contact_methodstring | nullrequired
  Example:email
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- checkin_periodinteger | nullrequired
  Example:30
- tagsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:High Priority
  colourstring | nullrequired
  Example:#FF0000
- primary_coordinatorobject | nullrequired
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  first_namestringrequired
  Example:John
  last_namestringrequired
  Example:Doe
  emailstringrequired
  Example:john.doe@example.com
- plan_managerobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:p1m2a3n4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Astalty Plan Management
  invoice_emailstring | nullrequired
  Example:invoices@astalty.com.au
- alertsobject[]required
  ▶Show 7 child attributesHide child attributes
  idstringrequired
  Example:p1a2l3e4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  titlestring | nullrequired
  Example:Medication
  contentstringrequired
  Example:Requires medication at midday
  typestringrequired
  Example:warning
  visible_to_support_workersbooleanrequired
  Example:true
  visible_when_schedulingbooleanrequired
  Example:true
  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