Skip to main content
POST
/
start_pipeline
Start flow run
curl --request POST \
  --url https://api.gumloop.com/api/v1/start_pipeline \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "xxxxxxxxxxxxxx",
  "saved_item_id": "xxxxxxxxxxxxxx",
  "recipient": "recipient@gmail.com",
  "subject": "Example of an Email Subject Line",
  "body": "Example of the Text of an Email Body",
  "topic": "weekly update"
}
'
{
  "run_id": "<string>",
  "saved_item_id": "<string>",
  "workbook_id": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Body

application/json

In addition to the documented top-level fields, you may include any additional inputs in the request body.

​
user_id
string
required

The id for the user initiating the flow.

​
saved_item_id
string
required

The id for the saved flow.

​
project_id
string

(Optional) The id of the project within which the flow is executed.

​
{key}
any

Arbitrary input value. The property key is matched by name to an Input node in the flow, and the entire body will be forwarded to any Webhook Input node.

Response

Flow started successfully

​
run_id
string
​
saved_item_id
string
​
workbook_id
string
​
url
string