curl --request POST \
--url http://localhost:8080/sequences/{sequenceId}/enrich \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": {
"kind": "batch_key",
"batch_key": "<string>"
},
"enrichers": [
"opencx"
],
"wait": true
}
'import requests
url = "http://localhost:8080/sequences/{sequenceId}/enrich"
payload = {
"scope": {
"kind": "batch_key",
"batch_key": "<string>"
},
"enrichers": ["opencx"],
"wait": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scope: {kind: 'batch_key', batch_key: '<string>'},
enrichers: ['opencx'],
wait: true
})
};
fetch('http://localhost:8080/sequences/{sequenceId}/enrich', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/sequences/{sequenceId}/enrich",
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([
'scope' => [
'kind' => 'batch_key',
'batch_key' => '<string>'
],
'enrichers' => [
'opencx'
],
'wait' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8080/sequences/{sequenceId}/enrich"
payload := strings.NewReader("{\n \"scope\": {\n \"kind\": \"batch_key\",\n \"batch_key\": \"<string>\"\n },\n \"enrichers\": [\n \"opencx\"\n ],\n \"wait\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/sequences/{sequenceId}/enrich")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": {\n \"kind\": \"batch_key\",\n \"batch_key\": \"<string>\"\n },\n \"enrichers\": [\n \"opencx\"\n ],\n \"wait\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences/{sequenceId}/enrich")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": {\n \"kind\": \"batch_key\",\n \"batch_key\": \"<string>\"\n },\n \"enrichers\": [\n \"opencx\"\n ],\n \"wait\": true\n}"
response = http.request(request)
puts response.read_body{
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scoped_count": 0,
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "enrich",
"status": "queued",
"scope": {
"kind": "batch_key",
"batch_key": "<string>"
},
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"enrichers": [
"opencx"
],
"model": "<string>",
"counts": {
"scoped": 0,
"processed": 0,
"no_data": 0,
"skipped_no_enrichment": 0,
"skipped_unchanged": 0,
"qualified": 0,
"disqualified": 0,
"errors": 0
},
"aggregates": {
"criteria": [
{
"kind": "must",
"text": "<string>",
"pass": 0,
"fail": 0,
"unsure": 0
}
],
"fit_distribution": {
"qualified": 0,
"not_qualified": 0,
"near_miss": 0
}
},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Enrich scoped people from org data (async run)
Snapshot what the organization knows about scoped people (profile, sessions, insights, transcripts, segments) onto their rows for judging. Small scopes can be awaited.
curl --request POST \
--url http://localhost:8080/sequences/{sequenceId}/enrich \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": {
"kind": "batch_key",
"batch_key": "<string>"
},
"enrichers": [
"opencx"
],
"wait": true
}
'import requests
url = "http://localhost:8080/sequences/{sequenceId}/enrich"
payload = {
"scope": {
"kind": "batch_key",
"batch_key": "<string>"
},
"enrichers": ["opencx"],
"wait": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scope: {kind: 'batch_key', batch_key: '<string>'},
enrichers: ['opencx'],
wait: true
})
};
fetch('http://localhost:8080/sequences/{sequenceId}/enrich', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/sequences/{sequenceId}/enrich",
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([
'scope' => [
'kind' => 'batch_key',
'batch_key' => '<string>'
],
'enrichers' => [
'opencx'
],
'wait' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8080/sequences/{sequenceId}/enrich"
payload := strings.NewReader("{\n \"scope\": {\n \"kind\": \"batch_key\",\n \"batch_key\": \"<string>\"\n },\n \"enrichers\": [\n \"opencx\"\n ],\n \"wait\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/sequences/{sequenceId}/enrich")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": {\n \"kind\": \"batch_key\",\n \"batch_key\": \"<string>\"\n },\n \"enrichers\": [\n \"opencx\"\n ],\n \"wait\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences/{sequenceId}/enrich")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": {\n \"kind\": \"batch_key\",\n \"batch_key\": \"<string>\"\n },\n \"enrichers\": [\n \"opencx\"\n ],\n \"wait\": true\n}"
response = http.request(request)
puts response.read_body{
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scoped_count": 0,
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "enrich",
"status": "queued",
"scope": {
"kind": "batch_key",
"batch_key": "<string>"
},
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"enrichers": [
"opencx"
],
"model": "<string>",
"counts": {
"scoped": 0,
"processed": 0,
"no_data": 0,
"skipped_no_enrichment": 0,
"skipped_unchanged": 0,
"qualified": 0,
"disqualified": 0,
"errors": 0
},
"aggregates": {
"criteria": [
{
"kind": "must",
"text": "<string>",
"pass": 0,
"fail": 0,
"unsure": 0
}
],
"fit_distribution": {
"qualified": 0,
"not_qualified": 0,
"near_miss": 0
}
},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the sequence
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
Which people to enrich: a labeled wave (batch_key), explicit contact_ids, or all_candidates.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Default: every implemented enricher.
1opencx Hold the response until the run finishes (up to ~50s) and return it, so a sample can be awaited instead of polled. IGNORED when the scope is larger than 50 people — dispatch those and let the dashboard show progress.
Response
Default Response
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$-9007199254740991 <= x <= 9007199254740991The finished run (counts + aggregates) when wait was set, the scope was small enough, and it settled in time. Null otherwise — read it with read_qualification_run.
Show child attributes
Show child attributes
Was this page helpful?