Automations

Run an automation

Runs an automation with the data passed in a POST request.

post/api/v1/scenario/run

Request

  • Base URL: https://cdn.app.axl.tech (the document declares no server; this is the origin it was published from)
  • URL: https://cdn.app.axl.tech/api/v1/scenario/run
  • Auth: API key in header Authorization

Request body

scenarioIdstring nullable

Automation ID

contactIdstring nullable

Contact ID

contactDataobject nullable
dataobject nullable

Response

OK

successboolean

True if the error list is empty or missing, false otherwise.

bodystring nullable

An object of any type containing the main payload of the response (e.g. the data being returned)

resetTokenboolean

Tells the client that the authentication token must be reset.

Changes

No recorded changes to this operation across all 1 revision of this API.