Skip to main content
cURL
curl --request POST \
  --url https://api.simplex.sh/start_segment \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segment_name": "<string>"
}'
{
  "succeeded": true
}
Starts a workflow segment.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

application/json
​
workflow_id
string<uuid>
required

The workflow ID.

​
segment_name
string
required

The name of the segment to start.

Response

Start segment response

​
succeeded
boolean

Indicates if the action succeeded.

Example:

true

⌘I