API ReferenceContactsParticipants

Create participant

Create a new participant. Plan manager scope from X-Plan-Manager-Id header.

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Request

This endpoint expects an object.
first_namestringOptional
middle_namestringOptional
last_namestringOptional
participant_numberstringOptional

NDIS participant number (numeric)

emailstringOptionalformat: "email"

Contact email (maps to contact_email)

stateenumOptional
statusenumOptional
Participant status
service_region_idenumOptional
postcodestringOptionalformat: "^\d{4}$"

4-digit postcode (e.g. ‘2000’)

approval_requiredbooleanOptional
date_of_birthdateOptional
phone_numberstringOptional
genderstringOptional
titlestringOptional
preferred_namestringOptional
approval_timeoutintegerOptional

Approval timeout (smallint)

address_line_1stringOptional
address_line_2stringOptional
citystringOptional
bsbstringOptionalformat: "^\d{3}-\d{3}$"

BSB in XXX-XXX format

bank_account_numberstringOptionalformat: "^\d{6,10}$"

6-10 digit account number

bank_account_namestringOptional
date_ceaseddateOptional
reason_for_leavingstringOptional
exit_reason_category_idstringOptionalformat: "uuid"
Exit reason category ID
exit_reason_subcategory_idstringOptionalformat: "uuid"

Exit reason subcategory ID (must belong to exit_reason_category_id)

aboriginal_torres_straitbooleanOptional

Aboriginal/Torres Strait Islander (maps to DB column aboroginal_torres_strait)

pronounsenumOptional
participant_approvedbooleanOptional
caldbooleanOptional
Culturally and linguistically diverse
interpreter_requiredbooleanOptional
onboard_datedateOptional
postal_statementbooleanOptional

Response

Participant created
idstringformat: "uuid"
Unique identifier for the participant
first_namestring
middle_namestring
last_namestring
participant_numberstring
NDIS participant number
emailstringformat: "email"
Contact email
statestring
statusstring
service_region_idstring
postcodestring
approval_requiredboolean
date_of_birthdate
phone_numberstring
genderstring
titlestring
preferred_namestring
approval_timeoutinteger
address_line_1string
address_line_2string
citystring
bsbstring
bank_account_numberstring
bank_account_namestring
date_ceaseddate
reason_for_leavingstring
aboriginal_torres_straitboolean
pronounsstring
participant_approvedboolean
caldboolean
interpreter_requiredboolean
onboard_datedate
postal_statementboolean
exit_reason_categoryobject

Reference to an exit reason category/subcategory (present only when set).

exit_reason_subcategoryobject

Reference to an exit reason category/subcategory (present only when set).

status_changesmap from strings to any

History of status changes (read-only)

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error