API Reference

Create Deliverable Change Request

Why would I use this?

This endpoint provides a way to request that a job's deliverable be changed. You might use this endpoint to change a jobs deliverable type from roof-only (type 2) to a complete exterior (type 3). For more information of Deliverable Change compatability see here.

Successful Response

A successful rsponse is a 201 with the updated changes reflected in the JSON response body. Follow along bekow to learn more about what makes up the request and response.

{
  "id": 1,
  "job_id": 123,
  "user_id": 456,
  "new_deliverable_id": 3,
  "old_deliverable_id": 1,
  "changed_at": null,
  "created_at": "2018-03-14T20:29:54.366Z",
  "updated_at": "2018-03-14T20:29:54.537Z",
  "state": "first_attempt"
}

Allowable Deliverable Change Requests

Old DeliverableNew Deliverable
Roof Only (2)Complete (3)
Total Living Area (6)Roof Only (2)
Total Living Area Plus (5)Roof Only (2)
Total Living Area (6)Complete (3)
Total Living Area Plus (5)Complete (3)
Capture Only (7)Roof Only (2)
Capture Only (7)Complete (3)
Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!