Start sequence blueprint

POST

sequence-blueprints

{blueprintId}

start

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": [
    {}
  ]
}
'

import requests

url = "https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start"

payload = { "candidateIds": [{}] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({candidateIds: [{}]})
};

fetch('https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'candidateIds' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start"

	payload := strings.NewReader("{\n  \"candidateIds\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"candidateIds\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"candidateIds\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

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

string

required

Sequence blueprint id to start.

Request body

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.

LinkedIn InMail sender

A LinkedIn InMail step without a chosen sender is sent from the LinkedIn account of the user who owns the API key. An InMail sender already chosen in Kalent is always kept. The blueprint itself is not modified. That user must have a synced LinkedIn account with InMail capability (Recruiter or Sales Navigator). Otherwise the start fails with linkedin_not_connected_or_syncing or linkedin_inmail_not_available in error.details.code.

The default sender is the owner of the API key. If several people share one key, InMails go out from the key owner’s LinkedIn account.

Errors

Code	HTTP
`validation_error`	400
`forbidden`	403
`plan_upgrade_required`	402
`not_found`	404
`temporal_unavailable`	503
`internal_error`	500

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"]}'

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": [
    {}
  ]
}
'

import requests

url = "https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start"

payload = { "candidateIds": [{}] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({candidateIds: [{}]})
};

fetch('https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'candidateIds' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start"

	payload := strings.NewReader("{\n  \"candidateIds\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"candidateIds\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"candidateIds\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

Getting Started

Sourcing

Candidates

Sequences

Start sequence blueprint

First time? Set up Authentication

Path parameters

Request body

Response

Prerequisites

LinkedIn InMail sender

Errors

First time? Set up Authentication

​Path parameters

​Request body

​Response

​Prerequisites

​LinkedIn InMail sender

​Errors

Path parameters

Request body

Response

Prerequisites

LinkedIn InMail sender

Errors