Command Palette

Search for a command to run...

Log In
Get help

Update an Organisation

put/public/v1/organisations/{organisation}

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

  • organisationstringrequired

    The organisation UUID

Body

application/json
  • namestringmax length 255
  • typestring | nullmax length 255
  • websitestring | nullmax length 255
  • emailstring<email> | nullmax length 255
  • phonestring | nullmax length 255
  • abnstring | null
  • ndis_registeredboolean | null
  • registration_numberstring | nullmax length 255
  • descriptionstring | null

Response

200application/json

OrganisationResource

  • dataobjectrequired
    ▶Show 10 child attributes
    • idstringrequired
      Example:o1r2g3a4-f5a6-47b8-9c0d-1e2f3a4b5c6d
    • namestringrequired
      Example:Astalty Therapy
    • typestring | nullrequired
      Example:Allied Health
    • websitestring | nullrequired
      Example:https://astalty.com.au
    • emailstring | nullrequired
      Example:contact@astalty.com.au
    • phonestring | nullrequired
      Example:0412345678
    • abnstring | nullrequired
      Example:12345678901
    • ndis_registeredboolean | nullrequired
      Example:true
    • registration_numberstring | nullrequired
      Example:4-ABC1234
    • descriptionstring | nullrequired
      Example:Provides occupational therapy services

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found
  • 422Validation error