Get Scenario Config

• Notification Scenario Configuration

Retrieves a notification scenario configuration by scenario id of an organization

Request

URI

GET

https://{api_host}/notification/api/scenario-configs/{scenarioId}

COPY

Path Parameters

string

scenarioId

Required

Notification Scenario Id

Query Parameters

boolean

expandBody

Optional

The 'body' field of each scenario configuration will be retrieved.

boolean

defaultConfig

Optional

The 'defaultConfig' of each scenario will be retrieved.

---

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Hide Details

OK

Returns NotificationScenarioConfig of type(s) application/json

{
    "body": "string",
    "enabled": false,
    "scenarioCategory": "string",
    "scenarioDescription": "string",
    "scenarioId": "string",
    "scenarioName": "string",
    "subject": "string"
}

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

boolean

enabled

Required

Notification scenario enabled

string

scenarioCategory

Optional

Notification scenario category

string

scenarioDescription

Optional

Notification scenario description

string

scenarioId

Required

Notification scenario id

string

scenarioName

Optional

Notification scenario name

string

subject

Optional

Constraints: maxLength: 998

Notification scenario subject

401

Hide Details

Unauthorized

Returns NotificationScenarioConfig of type(s) application/json

"NotificationScenarioConfig Object"

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

boolean

enabled

Required

Notification scenario enabled

string

scenarioCategory

Optional

Notification scenario category

string

scenarioDescription

Optional

Notification scenario description

string

scenarioId

Required

Notification scenario id

string

scenarioName

Optional

Notification scenario name

string

subject

Optional

Constraints: maxLength: 998

Notification scenario subject

403

Hide Details

Forbidden

Returns NotificationScenarioConfig of type(s) application/json

"NotificationScenarioConfig Object"

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

boolean

enabled

Required

Notification scenario enabled

string

scenarioCategory

Optional

Notification scenario category

string

scenarioDescription

Optional

Notification scenario description

string

scenarioId

Required

Notification scenario id

string

scenarioName

Optional

Notification scenario name

string

subject

Optional

Constraints: maxLength: 998

Notification scenario subject

404

Hide Details

Not Found

Returns NotificationScenarioConfig of type(s) application/json

"NotificationScenarioConfig Object"

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

boolean

enabled

Required

Notification scenario enabled

string

scenarioCategory

Optional

Notification scenario category

string

scenarioDescription

Optional

Notification scenario description

string

scenarioId

Required

Notification scenario id

string

scenarioName

Optional

Notification scenario name

string

subject

Optional

Constraints: maxLength: 998

Notification scenario subject

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/notification/api/scenario-configs/{scenarioId}
                

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Notification Scenario Configuration Operations

GET

Get All Scenario Configs

PATCH

Patch Config

POST

Create Or Update

DELETE

Delete

GET

Get Scenario Config

POST

Preview Notification Config

POST

Send Test Notification