PRproductive
Scenarios

Applies a scenario by overwriting its deal

Changed on

Apply the scenario to its deal by replacing the deal's sections, services, and bookings. Requires the Scenario Builder feature on the organization's plan.

patch/api/v2/scenarios/{id}/overwrite

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/scenarios/{id}/overwrite
  • Auth
    none declared

Path parameters

idstring required

ID

Request body

Example request

{
  "data": {
    "type": "scenarios",
    "attributes": {
      "apply_bookings": true,
      "confirm_bookings": false,
      "update_deal_value": true
    },
    "id": "42"
  }
}

Response

No Content

Changes

  • 7dcc2525e812Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

  • fa3060fd0144Revision changes
    • warning

      added the new bad_decimal_format enum value to the // response property for the response status

    • warning

      added the new non_finite_number enum value to the // response property for the response status

    • warning

      added the new null_bytes_in_params enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status