Skip to main content
POST
/
v3
/
workflows
/
{workflow_uid}
/
schedule
Launch a Workflow
curl --request POST \
  --url https://api.captaindata.co/v3/workflows/{workflow_uid}/schedule \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <api-key>' \
  --data '
{
  "job_name": "Get Yann Lecun Linkedin Profile",
  "steps": [
    {
      "step_uid": "xxxxxx-xxxxx-451f-ac94-2b41972ec6a7",
      "accounts": [
        "fc457336-63da-47f8-9a3c-53f2581d0ccb"
      ],
      "accounts_rotation_enabled": true,
      "parameters": {},
      "output_column": null
    }
  ],
  "inputs": [
    {
      "linkedin_profile_url": "https://www.linkedin.com/in/yann-lecun/",
      "meta": {
        "hubspot_company_id": "***",
        "hubspot_people_id": "***",
        "your_meta_key": "***"
      }
    }
  ],
  "unstructure_meta": false,
  "repeat_option": {
    "type": "minute",
    "value": 10
  }
}
'
{
  "workflow": {
    "uid": "xxxxxx-xxxx-4eeb-ada7-652fb498f540",
    "permalink": "extract-linkedin-people-profile085eef00-7e08-4abc-9971-217d3b65089b",
    "name": "Extract LinkedIn People Profile",
    "created_at": "2024-10-26T22:35:35.803378",
    "project_id": 1,
    "linked_templates": [
      "xxxxxxx-xxxxx-4288-8959-ef5759254ea1"
    ],
    "template_uid": "76fc370f-110b-4288-8959-ef5759254ea1"
  },
  "message": "Bot successfully scheduled.",
  "job_uid": "789416bd-9bc6-49be-9e21-d8037d1e393b"
}

Authorizations

​
Authorization
string
header
required

The Authorization header must include 'x-api-key' followed by your API key (e.g., 'Authorization: x-api-key YOUR_API_KEY').

​
x-project-id
string
header
required

Workspace UID required to identify the workspace.

Path Parameters

​
workflow_uid
string<uuid>
required

Body

application/json
​
job_name
string
required

Name of the workflow job to be scheduled.

Example:

"Get Yann Lecun Linkedin Profile"

​
steps
object[]
required

An array of steps to execute in the workflow.

​
inputs
object[]
required

List of inputs for the workflow. Each workflow has its own input keys; you'll need to adjust.

​
unstructure_meta
boolean
default:false

By default we store all your metadata inside the meta: {} object. Setting unstructure_meta to true will flatmap the JSON object, i.e. each meta key will be added to the final output.

Example:

false

​
repeat_option
Repeat Option · object

This option lets you create a repeated job (schedule).

Response

Successful Response