API Reference

Create Deliverable Change Request

This endpoint gives an integration the ability to upgrade a job's deliverable. For example, to upgrade a job from Roof Only ( `deliverable_id`: 2) to a complete exterior (`deliverable_id`: 3), this endpoint can be can be utilized. For more information of Deliverable Change compatability see here.

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)

Response Example

A successful response 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"
}

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!