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

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

multipart/form-data

Response

Start segment response

The response is of type object.