Update a call scenario

PATCH

/agents/{id}/scenarios/{scenarioId}

Updates title, use-when selector, Markdown guide, or enabled state. The generated key is stable and is not regenerated.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/agents//scenarios/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "whenToUse": "string",
    "scenario": "stringstri",
    "isEnabled": true
}'

Response Example

{
    "id": "string",
    "userId": "string",
    "agentId": "string",
    "key": "string",
    "title": "string",
    "whenToUse": "string",
    "scenario": "string",
    "isEnabled": true,
    "priority": 0,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-07-23 18:02:16

Reorder call scenarios for an agent

Delete a call scenario