Remap the audience columns without rebinding the table

curl --request PATCH \
  --url https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "mapping": {
    "company_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_domain_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_contacted_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linkedin_url_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/"

payload = { "mapping": {
        "company_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "company_domain_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_contacted_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "linkedin_url_column_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({
    mapping: {
      company_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      company_domain_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      email_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      first_name_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      last_contacted_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      last_name_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      linkedin_url_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/', 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.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/",
  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([
    'mapping' => [
        'company_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'company_domain_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'email_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'first_name_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'last_contacted_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'last_name_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'linkedin_url_column_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.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/"

	payload := strings.NewReader("{\n  \"mapping\": {\n    \"company_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"company_domain_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"email_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"first_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_contacted_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"linkedin_url_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\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.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mapping\": {\n    \"company_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"company_domain_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"email_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"first_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_contacted_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"linkedin_url_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/")

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  \"mapping\": {\n    \"company_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"company_domain_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"email_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"first_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_contacted_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"linkedin_url_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

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

{
  "audience_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audience_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "column_mapping": {
    "company_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_domain_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_contacted_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linkedin_url_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "edges": [
    {
      "branch": "default",
      "from_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "to_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "launched_at": "2023-11-07T05:31:56Z",
  "multithreading": {},
  "name": "<string>",
  "opt_out_footer_text": "<string>",
  "pause_reason": "<string>",
  "sending_window": {},
  "status": "draft",
  "status_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_count": 123,
  "steps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "message",
      "body_segments": [
        {
          "kind": "text",
          "builtin": "sender_first_name",
          "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "options": [
            "<string>"
          ],
          "prompt": "",
          "required": true,
          "text": ""
        }
      ],
      "condition_kind": "has_email",
      "condition_window_days": 45,
      "position": 0,
      "subject_segments": [
        {
          "kind": "text",
          "builtin": "sender_first_name",
          "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "options": [
            "<string>"
          ],
          "prompt": "",
          "required": true,
          "text": ""
        }
      ],
      "wait_amount": 0,
      "wait_unit": "days"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "ai_cta_label": "<string>",
  "ai_cta_url": "<string>",
  "ai_goal": "<string>",
  "ai_language": "<string>",
  "ai_reply_mode": "off",
  "ai_tone": "professional",
  "ai_translate": true,
  "bcc_addresses": [
    "<string>"
  ],
  "cc_addresses": [
    "<string>"
  ],
  "connection_requests_sent": 123,
  "connections_accepted": 123,
  "contacts_added": 123,
  "contacts_failed": 123,
  "contacts_finished": 123,
  "contacts_in_progress": 123,
  "emails_sent": 123,
  "last_synced_at": "2023-11-07T05:31:56Z",
  "linkedin_check_max_seconds": 123,
  "linkedin_check_min_seconds": 123,
  "linkedin_messages_sent": 123,
  "opportunity_values": {},
  "plain_text_only": true,
  "positive": 123,
  "positive_rate": 123,
  "replies": 123,
  "reply_rate": 123,
  "sender_profile_names": [
    "<string>"
  ],
  "senders_ready": true,
  "sending_priority": "new_contacts"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

PATCH

sequences

{sequence_id}

audience

mapping

Remap the audience columns without rebinding the table

curl --request PATCH \
  --url https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "mapping": {
    "company_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_domain_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_contacted_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linkedin_url_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/"

payload = { "mapping": {
        "company_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "company_domain_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_contacted_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "linkedin_url_column_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({
    mapping: {
      company_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      company_domain_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      email_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      first_name_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      last_contacted_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      last_name_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      linkedin_url_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/', 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.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/",
  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([
    'mapping' => [
        'company_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'company_domain_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'email_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'first_name_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'last_contacted_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'last_name_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'linkedin_url_column_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.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/"

	payload := strings.NewReader("{\n  \"mapping\": {\n    \"company_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"company_domain_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"email_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"first_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_contacted_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"linkedin_url_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\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.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mapping\": {\n    \"company_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"company_domain_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"email_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"first_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_contacted_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"linkedin_url_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/audience/mapping/")

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  \"mapping\": {\n    \"company_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"company_domain_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"email_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"first_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_contacted_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"last_name_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"linkedin_url_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

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

{
  "audience_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audience_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "column_mapping": {
    "company_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_domain_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_contacted_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_name_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "linkedin_url_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "edges": [
    {
      "branch": "default",
      "from_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "to_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "launched_at": "2023-11-07T05:31:56Z",
  "multithreading": {},
  "name": "<string>",
  "opt_out_footer_text": "<string>",
  "pause_reason": "<string>",
  "sending_window": {},
  "status": "draft",
  "status_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_count": 123,
  "steps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "message",
      "body_segments": [
        {
          "kind": "text",
          "builtin": "sender_first_name",
          "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "options": [
            "<string>"
          ],
          "prompt": "",
          "required": true,
          "text": ""
        }
      ],
      "condition_kind": "has_email",
      "condition_window_days": 45,
      "position": 0,
      "subject_segments": [
        {
          "kind": "text",
          "builtin": "sender_first_name",
          "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "options": [
            "<string>"
          ],
          "prompt": "",
          "required": true,
          "text": ""
        }
      ],
      "wait_amount": 0,
      "wait_unit": "days"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "ai_cta_label": "<string>",
  "ai_cta_url": "<string>",
  "ai_goal": "<string>",
  "ai_language": "<string>",
  "ai_reply_mode": "off",
  "ai_tone": "professional",
  "ai_translate": true,
  "bcc_addresses": [
    "<string>"
  ],
  "cc_addresses": [
    "<string>"
  ],
  "connection_requests_sent": 123,
  "connections_accepted": 123,
  "contacts_added": 123,
  "contacts_failed": 123,
  "contacts_finished": 123,
  "contacts_in_progress": 123,
  "emails_sent": 123,
  "last_synced_at": "2023-11-07T05:31:56Z",
  "linkedin_check_max_seconds": 123,
  "linkedin_check_min_seconds": 123,
  "linkedin_messages_sent": 123,
  "opportunity_values": {},
  "plain_text_only": true,
  "positive": 123,
  "positive_rate": 123,
  "replies": 123,
  "reply_rate": 123,
  "sender_profile_names": [
    "<string>"
  ],
  "senders_ready": true,
  "sending_priority": "new_contacts"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

sequence_id

string<uuid>

required

Body

application/json

mapping

ColumnMappingSchema · object

required

Show child attributes

Response

Successful Response

audience_table_id

string<uuid> | null

required

audience_view_id

string<uuid> | null

required

column_mapping

ColumnMappingSchema · object

required

Show child attributes

created_at

string<date-time>

required

edges

SequenceEdgeSchema · object[]

required

Show child attributes

string<uuid>

required

launched_at

string<date-time> | null

required

multithreading

Multithreading · object | null

required

name

string

required

opt_out_footer_text

string

required

pause_reason

string | null

required

sending_window

Sending Window · object | null

required

status

enum<string>

required

Lifecycle of a sequence.

DRAFT until launch; RUNNING sequences are locked against structural edits (pause → edit → resume); PAUSED stops scheduling while leaving every enrolment exactly where it is; COMPLETED is terminal.

Available options:

draft,

running,

paused,

completed

status_column_id

string<uuid> | null

required

step_count

integer

required

steps

SequenceStepSchema · object[]

required

Show child attributes

updated_at

string<date-time>

required

ai_cta_label

string | null

ai_cta_url

string | null

ai_goal

string | null

ai_language

string | null

ai_reply_mode

enum<string> | null

How far the AI reply layer may go on this sequence.

Auto-drafting is PHASE2 §8; the self-sending auto-pilot is INB-15. OFF is the default everywhere: a workspace opts in. AUTO_SEND is a further EXPLICIT opt-in: a HIGH-confidence draft on a healthy thread is approved automatically — through the exact same approve path a human uses, so sending stays one code path — while anything uncertain (lower confidence, a Negative/Wrong-contact label, OOO, a bounce, or a thread the agent has already answered five times) waits in Needs approval exactly like DRAFT_AND_QUEUE. An auto-sent draft records NO approver: a NULL approved_by_user_id on a SENT draft is the honest audit trail.

Available options:

off,

draft_and_queue,

auto_send

ai_tone

enum<string> | null

How a generated reply should read.

Available options:

professional,

friendly,

direct,

casual

ai_translate

boolean | null

bcc_addresses

string[]

SEQ-21: blind copies on every email this sequence sends.

cc_addresses

string[]

SEQ-21: addresses copied on every email this sequence sends.

connection_requests_sent

integer | null

connections_accepted

integer | null

SEQ-06: invitations from this sequence confirmed accepted. With connection_requests_sent this yields the acceptance rate.

contacts_added

integer | null

§21 rollup, list reads only. None when the rollup has never run for this org — show a zero state, not a fake 0.

contacts_failed

integer | null

contacts_finished

integer | null

contacts_in_progress

integer | null

emails_sent

integer | null

last_synced_at

string<date-time> | null

§20: when the audience-enrolment diff last completed. None until the first sync (launch runs one inline) — the Audience tab shows this plus a manual trigger, never a background job the user cannot see.

linkedin_check_max_seconds

integer | null

linkedin_check_min_seconds

integer | null

linkedin_messages_sent

integer | null

opportunity_values

Opportunity Values · object | null

SEQ-23: dollars per outcome label; None = tracking off.

Show child attributes

plain_text_only

boolean

default:true

SEQ-16: TRUE (recommended) sends text-only with formatting marks stripped; FALSE sends a multipart/alternative with the marks as HTML.

positive

integer | null

Threads labelled positive (rollup, list reads only).

positive_rate

number | null

replies

integer | null

SEQ-06: distinct contacts who replied — reply_rate's numerator.

reply_rate

number | null

sender_profile_names

string[]

Only meaningful on list reads: the assigned sender profiles' names.

senders_ready

boolean

default:true

Only meaningful on list reads: False when the sequence has assigned sender profiles but none currently has a connected mailbox.

sending_priority

string

default:new_contacts

SEQ-20: who gets scarce capacity first — new_contacts or follow_ups.

API reference

Endpoints

Remap the audience columns without rebinding the table

Authorizations

Path Parameters

Body

Response