API Reference
LiveSwitch Exchange

Run a Spark on a conversation

post
https://public-api.production.liveswitch.com/v1/conversations//sparks

Required scope: sparks.write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a Spark on a Conversation. If media is not yet available, the Spark queues and starts automatically when media arrives. Status is always "queued".

Path Params
uuid
required
Body Params
string | null

The ID of the Spark template to run. Obtain available IDs from GET /v1/spark-templates.

tasks
array of objects | null

Input values for tasks in the Spark template. Omit when the template has no user-facing input fields.
The Spark runs with the template's default task selection, matching Contact Admin.
Identify each task with tasks[].codeName from GET /v1/spark-templates.

tasks
shareWith
array of strings | null

Optional sharing targets for the completed Spark.
Accepted values: ["anyone"] to generate a public share URL.
Omit or pass an empty array for no public sharing.

shareWith
Response

Updated 5 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago