Log In

Update an NDIS Plan

put/public/v1/ndis-plans/{plan}

Moving a plan's dates moves the dates of every service on it and adjusts their funding periods to match, so a wrong date here reaches further than the plan row. start and end are read exactly as they are on create: instants converted to the provider's timezone, then floored and ceiled to that day. Send the provider's own UTC offset for the date in question, or send UTC. A participant's plans cannot overlap. Leaving is_pace out keeps the plan's current value, and the start may not move earlier than the plan already starts unless it is on or after 1 January 2019.

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.

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

  • planstringrequired

    The plan 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
  • 401Unauthenticated
  • 403Authorization error
  • 404Not found
  • 409A concurrent write moved another plan onto these dates first.
  • 422Validation error