API ReferenceContactsProviders

Update provider

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.

Path parameters

provider_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
entity_namestringOptional
abnstringOptional
emailstringOptionalformat: "email"
activebooleanOptional
Active status
primary_phone_numberstringOptional
Primary phone number
addressstringOptional
Street address
stateenumOptional

State (uppercase). Lowercase input is accepted and normalized to uppercase.

postcodestringOptionalformat: "^\d{4}$"

4-digit Australian postcode

citystringOptional
City
ndis_provider_numberstringOptional
NDIS provider number

Response

Updated provider
idstringformat: "uuid"
entity_namestring
abnstring
Australian Business Number
emailstringformat: "email"
activeboolean
Active status
primary_phone_numberstring
Primary phone number
addressstring
Street address
statestring

State (uppercase): NSW, QLD, VIC, SA, WA, TAS, ACT, NT

postcodestring

4-digit postcode

citystring
City
ndis_provider_numberstring
NDIS provider number
bsbstring

BSB (read-only)

bank_account_numberstring

Bank account number (read-only)

bank_account_namestring

Bank account name (read-only)

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error