Log In
Get help

Create an NDIS Plan

post/public/v1/participants/{participant}/ndis-plans

start and end are instants, not calendar dates. Each is converted to the provider's timezone and the plan then runs from the start of that day to the end of it. Send the provider's own UTC offset for the date in question, or send UTC. An offset ahead of the provider's puts a midnight instant on the previous day there, so 2026-07-01T00:00:00+11:00 stores a plan starting 30 June for a provider on AEST. A participant's plans cannot overlap. Leaving is_pace out takes it from the start date.

Overlapping dates are refused with a 422. Two calls that race each other onto the same participant are serialised, and the one that loses gets a 409.

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
  • startstring<date-time>required
  • endstring<date-time>required
  • is_paceboolean

Response

200application/json

NdisPlanResource

  • dataobjectrequired
    ▶Show 5 child attributes
    • idstringrequired
      Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
    • startstringrequired
      Example:2024-01-01T00:00:00+00:00
    • endstringrequired
      Example:2024-12-31T00:00:00+00:00
    • is_pacebooleanrequired
      Example:true
    • total_funded_supportsintegerrequired
      Example:5000000

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found
  • 409A concurrent write created an overlapping plan first.
  • 422Validation error