curl --request POST \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"created_from": "2023-11-07T05:31:56Z",
"created_to": "2023-11-07T05:31:56Z",
"enrolment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude": false,
"excluded_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"scope": "ids",
"search": "<string>",
"statuses": [],
"stop_reasons": []
}
'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/"
payload = {
"created_from": "2023-11-07T05:31:56Z",
"created_to": "2023-11-07T05:31:56Z",
"enrolment_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"exclude": False,
"excluded_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"scope": "ids",
"search": "<string>",
"statuses": [],
"stop_reasons": []
}
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({
created_from: '2023-11-07T05:31:56Z',
created_to: '2023-11-07T05:31:56Z',
enrolment_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
exclude: false,
excluded_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
scope: 'ids',
search: '<string>',
statuses: [],
stop_reasons: []
})
};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/', 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-journey/",
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([
'created_from' => '2023-11-07T05:31:56Z',
'created_to' => '2023-11-07T05:31:56Z',
'enrolment_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'exclude' => false,
'excluded_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'scope' => 'ids',
'search' => '<string>',
'statuses' => [
],
'stop_reasons' => [
]
]),
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-journey/"
payload := strings.NewReader("{\n \"created_from\": \"2023-11-07T05:31:56Z\",\n \"created_to\": \"2023-11-07T05:31:56Z\",\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude\": false,\n \"excluded_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": [],\n \"stop_reasons\": []\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-journey/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"created_from\": \"2023-11-07T05:31:56Z\",\n \"created_to\": \"2023-11-07T05:31:56Z\",\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude\": false,\n \"excluded_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": [],\n \"stop_reasons\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/")
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 \"created_from\": \"2023-11-07T05:31:56Z\",\n \"created_to\": \"2023-11-07T05:31:56Z\",\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude\": false,\n \"excluded_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": [],\n \"stop_reasons\": []\n}"
response = http.request(request)
puts response.read_body{
"changed": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Stop, pause, resume, retry or send now for many contacts
The Audience tab’s bulk actions, over the contacts a person ticked: listed ids, or scope=‘all’ for every contact the given filters match, less any excluded_ids. Each contact is judged on its own and one the action cannot apply to is skipped rather than failing the batch, because a selection is rarely uniform — ‘changed’ reports how many actually took it. ‘resume’ covers both waking a paused contact and undoing a reply stop; neither ever restarts a journey at step 1, and either finishes a wait the contact was in. ‘send_now’ makes a waiting contact’s next step due now instead of when its wait ends; pacing, the daily cap and approvals still apply.
curl --request POST \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"created_from": "2023-11-07T05:31:56Z",
"created_to": "2023-11-07T05:31:56Z",
"enrolment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"exclude": false,
"excluded_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"scope": "ids",
"search": "<string>",
"statuses": [],
"stop_reasons": []
}
'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/"
payload = {
"created_from": "2023-11-07T05:31:56Z",
"created_to": "2023-11-07T05:31:56Z",
"enrolment_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"exclude": False,
"excluded_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"scope": "ids",
"search": "<string>",
"statuses": [],
"stop_reasons": []
}
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({
created_from: '2023-11-07T05:31:56Z',
created_to: '2023-11-07T05:31:56Z',
enrolment_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
exclude: false,
excluded_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
scope: 'ids',
search: '<string>',
statuses: [],
stop_reasons: []
})
};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/', 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-journey/",
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([
'created_from' => '2023-11-07T05:31:56Z',
'created_to' => '2023-11-07T05:31:56Z',
'enrolment_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'exclude' => false,
'excluded_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'scope' => 'ids',
'search' => '<string>',
'statuses' => [
],
'stop_reasons' => [
]
]),
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-journey/"
payload := strings.NewReader("{\n \"created_from\": \"2023-11-07T05:31:56Z\",\n \"created_to\": \"2023-11-07T05:31:56Z\",\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude\": false,\n \"excluded_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": [],\n \"stop_reasons\": []\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-journey/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"created_from\": \"2023-11-07T05:31:56Z\",\n \"created_to\": \"2023-11-07T05:31:56Z\",\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude\": false,\n \"excluded_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": [],\n \"stop_reasons\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-journey/")
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 \"created_from\": \"2023-11-07T05:31:56Z\",\n \"created_to\": \"2023-11-07T05:31:56Z\",\n \"enrolment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"exclude\": false,\n \"excluded_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"scope\": \"ids\",\n \"search\": \"<string>\",\n \"statuses\": [],\n \"stop_reasons\": []\n}"
response = http.request(request)
puts response.read_body{
"changed": 123
}{
"detail": "<string>"
}{
"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 journey action applied to a selection of contacts.
The selection is exactly what the person ticked: some rows, or the header checkbox, which is every contact the filter matches less any unticked since. A scope='ids' request still has to name at least one contact.
stop, pause, resume, retry, send_now Only remove contacts added on or after this instant. The grid's date range, which a scope='all' removal has to honour or it reaches past what the person was looking at.
1000Read 'statuses' and 'stop_reasons' as 'everything but', matching the Contacts tab's one Include/Exclude toggle.
With scope='all', contacts to leave out: the rows unticked after ticking the header checkbox.
1000ids, all 255Where 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.
A contact the workspace's recontact rule refuses is STOPPED with
StopReason.COOLDOWN. There is deliberately no held state: a cooldown
settles a contact rather than parking them, so nothing here waits on a date
and nothing lets itself out later.
AWAITING_ACTION (F-25) is a contact parked behind a task that needs a person or a channel, modelled on PAUSED: live, keeps its step and its one-live-sequence slot, unclaimable because the tick claims strictly on ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by hand — only the outreach-task sweep does, once the task it waits on is decided or delivered. Deliberately not "awaiting approval": an AUTO-mode LinkedIn park is waiting for a browser rather than for anyone's approval, and this value is the word the Contacts tab shows for both.
active, claimed, paused, awaiting_action, completed, stopped, failed, suppressed, skipped_duplicate reply, unsubscribe, bounce, manual, company_reply, row_left_audience, step_removed, removed, cooldown, rejected Response
Successful Response
How many contacts actually took the action. A selection is rarely uniform, so rows the action cannot apply to are skipped, not failed.
Was this page helpful?