Required fields for POST /work_orders

Documentation lists title as required. Is that the only required field, or are there others I'm missing?

Testing with just title works. Testing with empty body returns 422. Want to confirm before we ship.

Parents
  • From what I've seen, title is the only hard requirement. YMMV depending on your account config though — if you have required custom fields enabled at the account level, those'll trigger 422s even if the base schema is satisfied.

    Here's a minimal payload that's worked for me across a few accounts:

    {
      "title": "HVAC diagnostic",
      "customer_id": "cus_abc123"
    }

    Worth noting: customer_id isn't strictly required by the API, but if you omit it you end up with an orphaned work order that's hard to find in the UI. Heads up on that.

Reply
  • From what I've seen, title is the only hard requirement. YMMV depending on your account config though — if you have required custom fields enabled at the account level, those'll trigger 422s even if the base schema is satisfied.

    Here's a minimal payload that's worked for me across a few accounts:

    {
      "title": "HVAC diagnostic",
      "customer_id": "cus_abc123"
    }

    Worth noting: customer_id isn't strictly required by the API, but if you omit it you end up with an orphaned work order that's hard to find in the UI. Heads up on that.

Children
No Data