curl --request POST \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-release/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"enrolment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"limit": 50000,
"scope": "ids",
"search": "<string>",
"statuses": []
}
'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-release/"
payload = {
"enrolment_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"limit": 50000,
"scope": "ids",
"search": "<string>",
"statuses": []
}
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({
enrolment_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
limit: 50000,
scope: 'ids',
search: '<string>',
statuses: []
})
};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-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/bulk-release/",
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([
'enrolment_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'limit' => 50000,
'scope' => 'ids',
'search' => '<string>',
'statuses' => [
]
]),
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}/contacts/bulk-release/"
payload := strings.NewReader("{\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 50000,\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": []\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://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-release/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 50000,\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-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>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 50000,\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": []\n}"
response = http.request(request)
puts response.read_body{
"released": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Release many held contacts into this sequence
The bulk twin of the single release, including the server-resolved scope=‘all’, so a cohort held by one overlap can be released in one action.
curl --request POST \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-release/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"enrolment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"limit": 50000,
"scope": "ids",
"search": "<string>",
"statuses": []
}
'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-release/"
payload = {
"enrolment_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"limit": 50000,
"scope": "ids",
"search": "<string>",
"statuses": []
}
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({
enrolment_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
limit: 50000,
scope: 'ids',
search: '<string>',
statuses: []
})
};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-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/bulk-release/",
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([
'enrolment_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'limit' => 50000,
'scope' => 'ids',
'search' => '<string>',
'statuses' => [
]
]),
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}/contacts/bulk-release/"
payload := strings.NewReader("{\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 50000,\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": []\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://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-release/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 50000,\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-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>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 50000,\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": []\n}"
response = http.request(request)
puts response.read_body{
"released": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Path Parameters
Body
ONE-1199: release many held contacts into THIS sequence.
Same shape as the bulk removal, including the server-resolved
scope='all', so a cohort held by one overlap can be released in a
single action. The release never touches the clock and never reaches
another sequence.
1000With scope='all', act on only the first n of the resolved set.
1 <= x <= 100000ids, all 255Defaults to the two held states, since nothing else can be released.
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 Response
Successful Response
Was this page helpful?