Skip to main content
POST
/
v1
/
sequence-blueprints
/
{blueprintId}
/
start
Start sequence blueprint
curl --request POST \
  --url https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "candidateIds": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.kalent.ai/llms.txt

Use this file to discover all available pages before exploring further.

First time? Set up Authentication

Learn how to authenticate your API requests with your API key.
Starts a dynamic outreach sequence workflow for the given blueprint and candidate ids. The blueprint must belong to a sourcing in your workspace and should contain valid steps created with Create sequence blueprint or Update sequence blueprint.

​
Path parameters

​
blueprintId
string
required
Sequence blueprint id to start.

​
Request body

​
candidateIds
array
required
Candidate ids to enroll in the sequence. The array must contain at least one id.

​
Response

When success is true, data contains:
  • started — whether the workflow was dispatched
  • blueprintId — started blueprint id
  • candidateCount — number of candidates requested
Poll progress with Get candidate dynamic sequence status using each candidateId.

​
Prerequisites

  • The blueprint must have at least one valid step.
  • Every candidateId must belong to the same sourcing as the blueprint.
  • Required outreach channels must be connected and synced in Kalent.
  • LinkedIn steps require a connected LinkedIn account.
  • WhatsApp steps require a connected WhatsApp account.
  • Email steps require a connected Gmail, Outlook, or IMAP account.

​
Errors

CodeHTTP
validation_error400
forbidden403
plan_upgrade_required402
not_found404
temporal_unavailable503
internal_error500
For forbidden errors caused by missing or disconnected outreach accounts, error.details.code indicates the blocked provider, such as linkedin_not_connected_or_syncing, whatsapp_not_connected_or_syncing, or email_not_connected_or_syncing. When the workspace plan does not include outreach integrations, the API returns plan_upgrade_required with billing remediation details: 
{
  "success": false,
  "error": {
    "code": "plan_upgrade_required",
    "message": "A Kalent subscription or plan upgrade is required to use outreach integrations. Please subscribe or upgrade your plan in Kalent billing: https://app.kalent.ai/settings/billing",
    "debugTrackingCode": "...",
    "details": {
      "code": "subscription_or_plan_upgrade_required",
      "action": "subscribe_or_upgrade",
      "capability": "use_outreach_integrations",
      "billingUrl": "https://app.kalent.ai/settings/billing"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "forbidden",
    "message": "LinkedIn account is not connected or not synced",
    "debugTrackingCode": "...",
    "details": {
      "code": "linkedin_not_connected_or_syncing"
    }
  }
}

curl -X POST https://app.kalent.ai/api/v1/sequence-blueprints/BLUEPRINT_ID/start \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"candidateIds":["CANDIDATE_ID"]}'