API ReferenceContactsProviders

Create provider

Create a new provider. 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.
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

Provider created
idstringOptionalformat: "uuid"
entity_namestringOptional
abnstringOptional
Australian Business Number
emailstringOptionalformat: "email"
activebooleanOptional
Active status
primary_phone_numberstringOptional
Primary phone number
addressstringOptional
Street address
statestringOptional

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

postcodestringOptional

4-digit postcode

citystringOptional
City
ndis_provider_numberstringOptional
NDIS provider number
bsbstringOptional

BSB (read-only)

bank_account_numberstringOptional

Bank account number (read-only)

bank_account_namestringOptional

Bank account name (read-only)

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error