Start Scenario

post

https://api.alcmeon.com/start-scenario

Start a scenario for a specific user

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

starting_box

string

required

The unique id associated with the scenario entry point you would like to trigger. The format of this value is opaque and subject to change for new scenarios without notice. The proper value can be found in the scenario editor by clicking in the top-right corner of a box and selecting the "Copy identifier" entry in the menu.

variables

object

A set of key/value pairs that will be stored in the user-specific variables used within the scenario. If you are unsure about what to store in this field, leave this dictionnary empty.

user

object

required

interrupt_ongoing_conversation

boolean

Defaults to false

If you want to force the message even if the user already has an ongoing conversation with the brand. For more details about blocking message when a user has an ongoing conversation, check our documentation

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returned upon succes

400Returned if the request body format is invalid.

403Returned if the user you are trying to reach is not accessible due to an ongoing conversation.

429Rate limit reached. For this route limit is 2000 requests per minute.