PRproductive
Scenarios

Create a scenario

Changed on

Create a new scenario. Requires the Scenario Builder feature on the organization's plan.

post/api/v2/scenarios

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
  • Auth
    none declared

Request body

Example request

{
  "data": {
    "type": "scenarios",
    "attributes": {
      "name": "Q1 staffing plan",
      "deal_id": 5678,
      "copy_services": true
    }
  }
}

Response

Single scenario

Example response

{
  "data": {
    "id": "42",
    "type": "scenarios",
    "attributes": {
      "name": "Q1 staffing plan",
      "created_at": "2026-01-15T09:30:00.000+01:00",
      "start_date": "2026-03-02",
      "end_date": "2026-05-29",
      "currency": "EUR",
      "budget_total": 960000,
      "budget_used": 480000,
      "revenue": 960000,
      "cost": 720000,
      "profit": 240000,
      "profit_margin": "25.0",
      "last_applied_at": "2026-02-20T14:00:00.000+01:00"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1"
        }
      },
      "deal": {
        "data": {
          "type": "deals",
          "id": "5678"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "7"
        }
      }
    }
  }
}

Changes

  • 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