Update enrollment step

cURL

curl --request PATCH \
  --url https://api.unifygtm.com/sequences/v1/enrollment-steps/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "subject": "<string>",
  "fallback_subject": "<string>",
  "body": "<string>",
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.unifygtm.com/sequences/v1/enrollment-steps/{id}"

payload = {
    "subject": "<string>",
    "fallback_subject": "<string>",
    "body": "<string>",
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    subject: '<string>',
    fallback_subject: '<string>',
    body: JSON.stringify('<string>'),
    version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.unifygtm.com/sequences/v1/enrollment-steps/{id}', 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://api.unifygtm.com/sequences/v1/enrollment-steps/{id}",
  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([
    'subject' => '<string>',
    'fallback_subject' => '<string>',
    'body' => '<string>',
    'version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.unifygtm.com/sequences/v1/enrollment-steps/{id}"

	payload := strings.NewReader("{\n  \"subject\": \"<string>\",\n  \"fallback_subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.unifygtm.com/sequences/v1/enrollment-steps/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subject\": \"<string>\",\n  \"fallback_subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/sequences/v1/enrollment-steps/{id}")

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  \"subject\": \"<string>\",\n  \"fallback_subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "AUTOMATIC_EMAIL",
  "status": "NOT_STARTED",
  "step_number": 2,
  "is_blocked": true,
  "is_bounced": true,
  "is_canceled": true,
  "is_opted_out": true,
  "is_paused": true,
  "is_replied": true,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "email": {
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subject": "<string>",
    "fallback_subject": "<string>",
    "body": "<string>",
    "is_ready": true,
    "is_edited": true,
    "is_root_message": true,
    "is_blocked": true,
    "scheduled_send_at": "2023-11-07T05:31:56Z",
    "sent_at": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "not_found",
  "message": "<string>"
}

{
  "status": "state_conflict",
  "message": "<string>",
  "reason": "STEP_COMPLETED"
}

{
  "status": "rate_limited",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

PATCH

sequences

enrollment-steps

{id}

cURL

curl --request PATCH \
  --url https://api.unifygtm.com/sequences/v1/enrollment-steps/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "subject": "<string>",
  "fallback_subject": "<string>",
  "body": "<string>",
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.unifygtm.com/sequences/v1/enrollment-steps/{id}"

payload = {
    "subject": "<string>",
    "fallback_subject": "<string>",
    "body": "<string>",
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    subject: '<string>',
    fallback_subject: '<string>',
    body: JSON.stringify('<string>'),
    version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.unifygtm.com/sequences/v1/enrollment-steps/{id}', 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://api.unifygtm.com/sequences/v1/enrollment-steps/{id}",
  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([
    'subject' => '<string>',
    'fallback_subject' => '<string>',
    'body' => '<string>',
    'version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.unifygtm.com/sequences/v1/enrollment-steps/{id}"

	payload := strings.NewReader("{\n  \"subject\": \"<string>\",\n  \"fallback_subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.unifygtm.com/sequences/v1/enrollment-steps/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subject\": \"<string>\",\n  \"fallback_subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/sequences/v1/enrollment-steps/{id}")

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  \"subject\": \"<string>\",\n  \"fallback_subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "AUTOMATIC_EMAIL",
  "status": "NOT_STARTED",
  "step_number": 2,
  "is_blocked": true,
  "is_bounced": true,
  "is_canceled": true,
  "is_opted_out": true,
  "is_paused": true,
  "is_replied": true,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "email": {
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subject": "<string>",
    "fallback_subject": "<string>",
    "body": "<string>",
    "is_ready": true,
    "is_edited": true,
    "is_root_message": true,
    "is_blocked": true,
    "scheduled_send_at": "2023-11-07T05:31:56Z",
    "sent_at": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "not_found",
  "message": "<string>"
}

{
  "status": "state_conflict",
  "message": "<string>",
  "reason": "STEP_COMPLETED"
}

{
  "status": "rate_limited",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

Overview

Replace the subject, fallback subject, or body of one person’s email before it sends. The change applies only to this enrollment and leaves the sequence’s template unchanged. Use it to revise copy that Unify drafted for an agentic sequence before you approve the enrollment, or to adjust a scheduled email for one recipient. Include only the fields you want to change. The request must include at least one of subject, fallback_subject, or body. Only email steps have copy; other step types return 400 Bad Request. Get step IDs from List enrollment steps.

Examples

Set UNIFY_API_KEY to your API key and replace the example step ID and version_id with values from Get enrollment step.

Rewrite a drafted email

This request replaces the email body and keeps the first-name variable from the original copy:

curl --request PATCH \
  --url "https://api.unifygtm.com/sequences/v1/enrollment-steps/3f6c2a90-58d1-4e7b-9a43-2c8e1d7b5f06" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "body": "<p>Hi {{variable::person.firstName}},</p><p>Congratulations on the new office in Austin. Would a short call next week be useful?</p>",
  "version_id": "0b7d9e4c-6a21-4f3e-8c55-9d1a2b3c4e5f"
}'

The response returns the step with its new copy and a new email.version_id.

Change the subject of a thread

Send a subject only to the first email of a thread:

{
  "subject": "{{variable::company.name}} and Unify",
  "fallback_subject": "Quick introduction",
  "version_id": "0b7d9e4c-6a21-4f3e-8c55-9d1a2b3c4e5f"
}

Unify uses fallback_subject if the variable in subject cannot be resolved when the email sends.

Write the copy

body is HTML and replaces the step’s entire body. Template variables and snippets appear in the copy as {{ ... }} tokens, such as {{variable::person.firstName}}. Keep the tokens you want to preserve. To add a variable or snippet, copy its token from the sequence’s template, which Get sequence step returns in config.body. After an update, Unify resolves the tokens in the new copy for this person. email.is_ready is false until they are resolved, and the email does not send before then. Only the first email of a thread accepts subject and fallback_subject. Its email.is_root_message is true. Later emails reply in the same thread and reuse its subject, so a subject change on a reply returns 400 Bad Request.

Avoid overwriting other edits

Send the email.version_id you last read as version_id. If the copy changed after that version, for example because a teammate edited it in Unify, the API returns 409 Conflict with reason set to VERSION_OUTDATED. Get the step again, apply your change to the latest copy, and retry. Without version_id, the update replaces the current copy regardless of earlier changes. The API also returns 409 Conflict once the step has sent or the enrollment has ended, for example because the person replied or opted out. reason identifies the cause. Only VERSION_OUTDATED can be resolved by retrying.

Authorizations

x-api-key

string

header

required

Path Parameters

string<uuid>

required

String UUID value.

Body

application/json

Option 1
Option 2
Option 3

Request body for updating the email copy of an enrollment step. At least one of subject, fallback_subject or body must be provided.

subject and fallback_subject are only accepted on root messages.
body is HTML. Template variables and snippets are written as {{ ... }} tokens. Must not be blank.
version_id is the copy version the edit is based on. The update is rejected with a conflict when the copy has changed since that version.

subject

string

required

fallback_subject

string

body

string

Required string length: 1 - 200000

version_id

string<uuid>

String UUID value.

Response

Response returned when an enrollment step's email copy is updated.

string<uuid>

required

String UUID value.

created_at

string<date-time>

required

String value representing an RFC 3339 datetime.

updated_at

string<date-time>

required

String value representing an RFC 3339 datetime.

enrollment_id

string<uuid>

required

String UUID value.

sequence_id

string<uuid>

required

String UUID value.

step_id

string<uuid>

required

ID of the sequence step this enrollment step was created from.

type

enum<string>

required

Type of a sequence enrollment step.

Available options:

AUTOMATIC_EMAIL,

MANUAL_EMAIL,

ACTION_ITEM,

ZAPIER,

PHONE_CALL,

MANUAL_LINKEDIN_PROFILE_VIEW,

MANUAL_LINKEDIN_CONNECTION,

MANUAL_LINKEDIN_MESSAGE

status

enum<string>

required

Status of an individual sequence enrollment step.

Available options:

NOT_STARTED,

SCHEDULED,

PENDING,

FINISHED,

CANCELED,

ERRORED,

UNREACHABLE

step_number

integer

required

Position of the step in the enrollment, starting at 1. Null until the step is expected to run or has finished.

Required range: x >= 1

is_blocked

boolean

required

is_bounced

boolean

required

is_canceled

boolean

required

is_opted_out

boolean

required

is_paused

boolean

required

is_replied

boolean

required

started_at

string<date-time> | null

required

String value representing an RFC 3339 datetime.

ended_at

string<date-time> | null

required

String value representing an RFC 3339 datetime.

object | null

required

Email copy for email steps. Null for other step types.

Show child attributes

⌘I

Unify platform

MCP

Developer guides

API reference

SDKs

Update enrollment step

Overview

Examples

Write the copy

Avoid overwriting other edits

Authorizations

Path Parameters

Body

Response

​Overview

​Examples

​Write the copy

​Avoid overwriting other edits

Authorizations

Path Parameters

Body

Response

Overview

Examples

Write the copy

Avoid overwriting other edits