v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Actions

Start scenario

Run a Callr Actions scenario offline. This will execute the api-initiated branch of the scenario.

post/actions/{sid}/runs

Path parameters

sidstring required

Short ID

Example:callrsid

Resource SID (8 lowercase alphanumeric characters)

Request body

variablesActionsVariables

Key/value object defining variables. Keys must start with a $ followed by a letter. Keys not matching the regex ^\$[a-zA-Z][a-zA-Z0-9_]{0,254}$ will be silently ignored. Values can be of any type.

Example request

{
  "variables": {
    "$customID": 42,
    "$target": "+15559820800",
    "$mylist": [
      "listItem1",
      "listItem2"
    ],
    "$myobject": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Response

Starting api-initiated branch

runidstring required

Example response

{
  "runid": "api:9MNAB2H6"
}