Update sequence blueprint

PATCH

sequence-blueprints

{blueprintId}

curl --request PATCH \
  --url https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "steps": [
    {}
  ],
  "config": {}
}
'

import requests

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

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

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

print(response.text)

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

fetch('https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'steps' => [
        [
                
        ]
    ],
    'config' => [
        
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {}\n  ],\n  \"config\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {}\n  ],\n  \"config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {}\n  ],\n  \"config\": {}\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.

Updates a sequence blueprint in your workspace. Send at least one of name, steps, or config.

Path parameters

string

required

Sequence blueprint id returned by Create sequence blueprint.

Request body

string

New display name for the blueprint.

array

Ordered outreach steps. Sending steps replaces the full blueprint step list. See Step format.

object

Optional sequence-level configuration.

Step shape

Each item in steps must be an object with this shape:

Field	Type	Required	Description
`id`	string	Yes	Stable client-generated step id, unique within the blueprint.
`name`	string	Yes	Human-readable step label.
`type`	string	Yes	`LINKEDIN`, `WHATSAPP`, `EMAIL`, or `SMS`.
`linkedInType`	string	Only for LinkedIn	Required when `type` is `LINKEDIN`; forbidden for other types.
`content`	string	Yes	Message body. For `LINKEDIN_INVITATION`, content is accepted but stored as an empty string.
`subject`	string	Email only	Email subject.
`temporalityType`	string	Yes	`ASAP`, `DELAYED`, or `AFTER_INVITATION_SETTLED`.
`delay`	object	For delayed steps	Required when `temporalityType` is `DELAYED`.
`delay.value`	integer	With `delay`	Positive delay value.
`delay.unit`	string	With `delay`	`day`, `minute`, or `second`.
`contentSource`	string	No	`manual` or `suggestedByKalent`.
`config.userId`	string	No	Optional sender/user override.
`policy.skipStepIfNoContact`	boolean	No	Skip the step when the required contact is unavailable.
`policy.autoValidateAIDraft`	boolean	No	Automatically validate AI-generated drafts.
`policy.inviteTimeoutDays`	integer	No	Positive number of days before invite-related follow-up logic.

Allowed linkedInType values:

LINKEDIN_INVITATION
LINKEDIN_INVITATION_WITH_MESSAGE
LINKEDIN_MESSAGE
LINKEDIN_INMAIL

Only one invite step is allowed per blueprint: either LINKEDIN_INVITATION or LINKEDIN_INVITATION_WITH_MESSAGE.

Supported template variables

Only these variables are supported in content and subject:

Variable	Meaning
`{{firstname}}`	Candidate first name
`{{lastname}}`	Candidate last name
`{{candidateJobTitle}}`	Candidate current job title
`{{candidateCompanyName}}`	Candidate current company
`{{candidateLocation}}`	Candidate location
`{{sourcingJobTitle}}`	Sourcing target job title
`{{sourcingLocation}}`	Sourcing target location
`{{recruiterFirstname}}`	Recruiter first name
`{{recruiterLastname}}`	Recruiter last name

Unknown variables such as {{firstName}}, {{company}}, or {{job}} are rejected with validation_error. Do not use unresolved bracket placeholders such as [company], [specific project or stack], [one-pager link], or [1 detail to add] in content or subject. Replace them with real text, remove that part of the sentence, or ask the user for the missing detail before updating the blueprint. Payloads containing bracket placeholders are rejected with validation_error.

Validation errors

Invalid payloads return the standard error envelope:

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "Validation failed",
    "debugTrackingCode": "...",
    "issues": [
      {
        "path": ["steps", 0, "linkedInType"],
        "message": "linkedInType is required when type is LINKEDIN"
      }
    ]
  }
}

Example

{
  "steps": [
    {
      "id": "step-1",
      "name": "LinkedIn invite",
      "type": "LINKEDIN",
      "linkedInType": "LINKEDIN_INVITATION_WITH_MESSAGE",
      "content": "Hi {{firstname}}, I came across your profile and wanted to connect.",
      "temporalityType": "ASAP",
      "contentSource": "manual"
    },
    {
      "id": "step-2",
      "name": "Email follow-up",
      "type": "EMAIL",
      "subject": "Quick follow-up",
      "content": "Hi {{firstname}}, would you be open to discussing the role?",
      "temporalityType": "DELAYED",
      "delay": { "value": 2, "unit": "day" },
      "policy": { "skipStepIfNoContact": true }
    }
  ]
}

Response

When success is true, data contains blueprintId, name, and sourcingId.

Errors

Code	HTTP
`validation_error`	400
`not_found`	404
`internal_error`	500

curl -X PATCH https://app.kalent.ai/api/v1/sequence-blueprints/BLUEPRINT_ID \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"steps":[{"id":"step-1","name":"LinkedIn invite","type":"LINKEDIN","linkedInType":"LINKEDIN_INVITATION_WITH_MESSAGE","content":"Hi {{firstname}}, I wanted to connect.","temporalityType":"ASAP"}]}'

Start sequence blueprintStart dynamic outreach sequences from a blueprint for candidates.

Update sequence blueprint

curl --request PATCH \
  --url https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "steps": [
    {}
  ],
  "config": {}
}
'

import requests

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

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

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

print(response.text)

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

fetch('https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'steps' => [
        [
                
        ]
    ],
    'config' => [
        
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {}\n  ],\n  \"config\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.kalent.ai/api/v1/sequence-blueprints/{blueprintId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {}\n  ],\n  \"config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {}\n  ],\n  \"config\": {}\n}"

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

Getting Started

Search

Sourcing & candidates

LinkedIn contact enrichment

Update sequence blueprint

First time? Set up Authentication

Path parameters

Request body

Step shape

Supported template variables

Validation errors

Example

Response

Errors

First time? Set up Authentication

​Path parameters

​Request body

​Step shape

​Supported template variables

​Validation errors

​Example

​Response

​Errors

Path parameters

Request body

Step shape

Supported template variables

Validation errors

Example

Response

Errors