Scenario Sections

Groupings of services within a scenario, mirroring the deal's sections. All scenario endpoints require the Scenario Builder feature on the organization's plan.

Attributes

editor_config object
Response Request Nullable

Rich text editor configuration and content for this section's description.
id integer
Parameter `filter`

The unique identifier of this section.
name string
Response Request Parameter `filter` Nullable

The name of this section.
organization organization
Response

The organization this section belongs to.
position integer
Response Request Nullable

The sort position of this section within the scenario.
preferences object
Response Request Nullable

User-specific display preferences for this section, stored as key-value settings.
scenario scenario
Response

The scenario this section belongs to.
scenario_id integer
Request Parameter `filter`

ID of the scenario this section belongs to.

Examples

Loading example

Operations

GET /api/v2/scenario_sections
Get scenario sections
GET /api/v2/scenario_sections/{id}
Gets a scenario section
POST /api/v2/scenario_sections
Create a scenario section
PATCH /api/v2/scenario_sections/{id}
Update a scenario section
DELETE /api/v2/scenario_sections/{id}
Deletes a scenario section