curl --request POST \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/', 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}/contacts/{enrolment_id}/release/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"bounced": true,
"company_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"current_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"due_at": "2023-11-07T05:31:56Z",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replied_at": "2023-11-07T05:31:56Z",
"status": "active",
"stop_reason": "reply",
"updated_at": "2023-11-07T05:31:56Z",
"company": "<string>",
"display_name": "<string>",
"excluded_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold_list_name": "<string>",
"hold_reason": "person",
"hold_source_contacted_at": "2023-11-07T05:31:56Z",
"hold_until": "2023-11-07T05:31:56Z",
"linkedin_url": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Release one held contact into this sequence
ONE-1199: enrol a contact the workspace’s cooldown or an exclusion list is holding back, ahead of its window. Applies to THIS sequence only — the contact stays held everywhere else and the clock is untouched.
curl --request POST \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/', 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}/contacts/{enrolment_id}/release/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/{enrolment_id}/release/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"bounced": true,
"company_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"current_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"due_at": "2023-11-07T05:31:56Z",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replied_at": "2023-11-07T05:31:56Z",
"status": "active",
"stop_reason": "reply",
"updated_at": "2023-11-07T05:31:56Z",
"company": "<string>",
"display_name": "<string>",
"excluded_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold_list_name": "<string>",
"hold_reason": "person",
"hold_source_contacted_at": "2023-11-07T05:31:56Z",
"hold_until": "2023-11-07T05:31:56Z",
"linkedin_url": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Response
Successful Response
Where one contact stands in one sequence.
ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the
in-flight guard between claim and outcome. PAUSED (SEQ-30) is a deliberate
per-contact hold: unclaimable because the tick claims strictly on ACTIVE,
yet still LIVE — it keeps its step and its one-live-sequence slot, and a
compliance stop (reply, unsubscribe) reaches it. Everything else is
settled: COMPLETED walked off the end; STOPPED was halted (reply,
unsubscribe, bounce, manual, company pause); FAILED is terminal per the
phase-1 ruling; SUPPRESSED was on the do-not-contact list;
SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the
reason visible in the grid.
ONE-1199 adds two HELD states, which are neither live nor settled. COOLDOWN
is a contact the workspace's recontact rule is holding back: it carries the
eligible-again instant in due_at and resolves ITSELF at the first
release sweep after that instant. It is deliberately outside
uq_sequence_enrolment_one_live — a hold is not a live cadence, so two
sequences may each hold the same person and each releases independently —
and outside the due-queue's partial index, so the tick can never claim one.
EXCLUDED is an exclusion-list match: the opposite fact, because there is no
date on which it resolves.
active, claimed, paused, completed, stopped, failed, suppressed, skipped_duplicate, cooldown, excluded reply, unsubscribe, bounce, manual, company_reply, row_left_audience, step_removed, removed Which exclusion list excluded this contact.
Which dial holds this contact: person or account.
person, account The contact this hold is measured from. For an account hold this is a colleague's; the colleague is deliberately never named.
When a held contact becomes eligible again.
Was this page helpful?