Choose workspace setups
curl --request POST \
--url https://api.enrik.ai/v1/onboarding/setup/setups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"operationId": "0199b5e0-0000-7000-8000-00000000e004",
"generation": 1,
"expectedRevision": 2,
"setups": {
"icpProfiles": true,
"targetSegments": true,
"buyingSignals": false
}
}
'import requests
url = "https://api.enrik.ai/v1/onboarding/setup/setups"
payload = {
"operationId": "0199b5e0-0000-7000-8000-00000000e004",
"generation": 1,
"expectedRevision": 2,
"setups": {
"icpProfiles": True,
"targetSegments": True,
"buyingSignals": False
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
operationId: '0199b5e0-0000-7000-8000-00000000e004',
generation: 1,
expectedRevision: 2,
setups: {icpProfiles: true, targetSegments: true, buyingSignals: false}
})
};
fetch('https://api.enrik.ai/v1/onboarding/setup/setups', 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.enrik.ai/v1/onboarding/setup/setups",
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([
'operationId' => '0199b5e0-0000-7000-8000-00000000e004',
'generation' => 1,
'expectedRevision' => 2,
'setups' => [
'icpProfiles' => true,
'targetSegments' => true,
'buyingSignals' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.enrik.ai/v1/onboarding/setup/setups"
payload := strings.NewReader("{\n \"operationId\": \"0199b5e0-0000-7000-8000-00000000e004\",\n \"generation\": 1,\n \"expectedRevision\": 2,\n \"setups\": {\n \"icpProfiles\": true,\n \"targetSegments\": true,\n \"buyingSignals\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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("https://api.enrik.ai/v1/onboarding/setup/setups")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"operationId\": \"0199b5e0-0000-7000-8000-00000000e004\",\n \"generation\": 1,\n \"expectedRevision\": 2,\n \"setups\": {\n \"icpProfiles\": true,\n \"targetSegments\": true,\n \"buyingSignals\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enrik.ai/v1/onboarding/setup/setups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"operationId\": \"0199b5e0-0000-7000-8000-00000000e004\",\n \"generation\": 1,\n \"expectedRevision\": 2,\n \"setups\": {\n \"icpProfiles\": true,\n \"targetSegments\": true,\n \"buyingSignals\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"state": {
"id": "0199b5e0-0000-7000-8000-00000000d001",
"generation": 1,
"revision": 3,
"draft": {
"website": "https://example.com",
"source": "website",
"locale": "en",
"aiOutcome": {
"status": "drafted"
},
"findings": {
"companyName": "Analytical Engines",
"productDescription": "Builds engines that compute.",
"buyerRoles": [
"Head of Engineering",
"Chief Technology Officer"
],
"markets": [
"Austria",
"Germany"
]
}
},
"setups": {
"icpProfiles": true,
"targetSegments": true,
"buyingSignals": false
},
"confirmed": {
"profileId": "0199b5e0-0000-7000-8000-00000000d002",
"profile": {
"companyName": "Analytical Engines",
"website": "https://example.com",
"productDescription": "Builds engines that compute.",
"valueProposition": null,
"targetRegion": "Austria, Germany",
"buyerPersonas": [
"Head of Engineering",
"Chief Technology Officer"
],
"mainPainSolved": null,
"salesMotion": null,
"exclusionNotes": null
},
"confirmedAt": "2026-10-07T09:05:00.000Z"
},
"createdAt": "2026-10-07T09:00:00.000Z",
"updatedAt": "2026-10-07T09:06:00.000Z"
},
"profileHash": "bb55bb4ded3975cf8a62c0da6d87c7a83723ac5b1226de6b629b0bbe08fc297b"
}{
"error": {
"code": "malformed_json",
"message": "Bad Request",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unauthenticated",
"message": "Unauthorized",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Forbidden",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "conflict",
"message": "Conflict",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "payload_too_large",
"message": "Payload Too Large",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unsupported_media_type",
"message": "Unsupported Media Type",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "validation_error",
"message": "Unprocessable Entity",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "internal_error",
"message": "Internal Server Error",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "service_unavailable",
"message": "Service Unavailable",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "not_found",
"message": "Not found",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}websiteOnboarding
Choose workspace setups
Requires one UUID Idempotency-Key matching body operationId. Records immutable choices once per confirmed generation. API-key selection also acknowledges the handoff atomically; browser selection requires prior acknowledgement. Target segments require ICP profiles. Explicitly selecting nothing is valid. Reset starts a new selection; exact receipt replay preserves historical responses.
POST
/
v1
/
onboarding
/
setup
/
setups
Choose workspace setups
curl --request POST \
--url https://api.enrik.ai/v1/onboarding/setup/setups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"operationId": "0199b5e0-0000-7000-8000-00000000e004",
"generation": 1,
"expectedRevision": 2,
"setups": {
"icpProfiles": true,
"targetSegments": true,
"buyingSignals": false
}
}
'import requests
url = "https://api.enrik.ai/v1/onboarding/setup/setups"
payload = {
"operationId": "0199b5e0-0000-7000-8000-00000000e004",
"generation": 1,
"expectedRevision": 2,
"setups": {
"icpProfiles": True,
"targetSegments": True,
"buyingSignals": False
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
operationId: '0199b5e0-0000-7000-8000-00000000e004',
generation: 1,
expectedRevision: 2,
setups: {icpProfiles: true, targetSegments: true, buyingSignals: false}
})
};
fetch('https://api.enrik.ai/v1/onboarding/setup/setups', 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.enrik.ai/v1/onboarding/setup/setups",
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([
'operationId' => '0199b5e0-0000-7000-8000-00000000e004',
'generation' => 1,
'expectedRevision' => 2,
'setups' => [
'icpProfiles' => true,
'targetSegments' => true,
'buyingSignals' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.enrik.ai/v1/onboarding/setup/setups"
payload := strings.NewReader("{\n \"operationId\": \"0199b5e0-0000-7000-8000-00000000e004\",\n \"generation\": 1,\n \"expectedRevision\": 2,\n \"setups\": {\n \"icpProfiles\": true,\n \"targetSegments\": true,\n \"buyingSignals\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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("https://api.enrik.ai/v1/onboarding/setup/setups")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"operationId\": \"0199b5e0-0000-7000-8000-00000000e004\",\n \"generation\": 1,\n \"expectedRevision\": 2,\n \"setups\": {\n \"icpProfiles\": true,\n \"targetSegments\": true,\n \"buyingSignals\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enrik.ai/v1/onboarding/setup/setups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"operationId\": \"0199b5e0-0000-7000-8000-00000000e004\",\n \"generation\": 1,\n \"expectedRevision\": 2,\n \"setups\": {\n \"icpProfiles\": true,\n \"targetSegments\": true,\n \"buyingSignals\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"state": {
"id": "0199b5e0-0000-7000-8000-00000000d001",
"generation": 1,
"revision": 3,
"draft": {
"website": "https://example.com",
"source": "website",
"locale": "en",
"aiOutcome": {
"status": "drafted"
},
"findings": {
"companyName": "Analytical Engines",
"productDescription": "Builds engines that compute.",
"buyerRoles": [
"Head of Engineering",
"Chief Technology Officer"
],
"markets": [
"Austria",
"Germany"
]
}
},
"setups": {
"icpProfiles": true,
"targetSegments": true,
"buyingSignals": false
},
"confirmed": {
"profileId": "0199b5e0-0000-7000-8000-00000000d002",
"profile": {
"companyName": "Analytical Engines",
"website": "https://example.com",
"productDescription": "Builds engines that compute.",
"valueProposition": null,
"targetRegion": "Austria, Germany",
"buyerPersonas": [
"Head of Engineering",
"Chief Technology Officer"
],
"mainPainSolved": null,
"salesMotion": null,
"exclusionNotes": null
},
"confirmedAt": "2026-10-07T09:05:00.000Z"
},
"createdAt": "2026-10-07T09:00:00.000Z",
"updatedAt": "2026-10-07T09:06:00.000Z"
},
"profileHash": "bb55bb4ded3975cf8a62c0da6d87c7a83723ac5b1226de6b629b0bbe08fc297b"
}{
"error": {
"code": "malformed_json",
"message": "Bad Request",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unauthenticated",
"message": "Unauthorized",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Forbidden",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "conflict",
"message": "Conflict",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "payload_too_large",
"message": "Payload Too Large",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unsupported_media_type",
"message": "Unsupported Media Type",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "validation_error",
"message": "Unprocessable Entity",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "internal_error",
"message": "Internal Server Error",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "service_unavailable",
"message": "Service Unavailable",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "not_found",
"message": "Not found",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}Authorizations
An Enrik API key, sent as Authorization: Bearer <key>. A key reaches public operations only, and only those whose scopes it holds. A few parameters need a scope beyond their operation’s, which the parameter names. The scopes:
setup:read: Read the workspace setup and its company profile.setup:run: Change the setup: confirm the company profile, authorize sponsored drafting and background company research, choose what to set up and complete setup.workspace:read: Read the workspace’s own profile: its health summary and setup state.crm:read: Read companies with their signals, contacts and the saved views over them.crm:write: Create, update and restore companies and contacts, and create, update and delete saved views.crm:delete: Delete companies and contacts.twin:read: Read the Company Twin: structured company knowledge and its signals.discovery:read: Read ICP profiles, ICP assessments, discovery briefs, discovery jobs, candidates and the signal library.discovery:write: Create and change ICP profiles, discovery briefs and signal-definition drafts, and review discovery candidates.discovery:run: Create, start and cancel discovery jobs, and edit a draft one. Uses provider budget.enrichment:read: Read the enrichment configuration and its results, including a record’s enrichment, formula and custom-API cells.enrichment:run: Launch and cancel enrichment. Spends enrichment credits.automation:read: Read workflows and agents with their run history, including a record’s agent cells.automation:run: Run existing workflows and agents.exports:read: Read export jobs and the fields an export can carry.exports:run: Create, preview, start, cancel and archive CSV exports of companies, contacts and candidates, and download the file. Also needscrm:read. Delivering an export to a webhook destination stays in the app.integrations:read: Read connections, field mappings, CRM sync jobs and webhook destinations.webhooks:read: Read webhook subscriptions, the event types they can name and their delivery log.webhooks:write: Subscribe a receiver URL to webhook events; edit, test, pause, resume and archive a subscription and rotate its signing secret; redeliver an event. Only workspace owners and admins can grant it.reporting:read: Read analytics and dashboards.assistant:read: Read the Assistant: its threads, messages and pending approvals.assistant:run: Converse with the Assistant. Uses the workspace’s AI quota.assistant:write: Approve or reject the changes the Assistant proposes.
Headers
A key you choose for this request, such as a UUID. Retrying with the same key returns the first result instead of doing the work twice.
Required string length:
1 - 200Body
application/json
The setups chosen for the confirmed generation.
The command’s id: the same UUID as its Idempotency-Key header.
Pattern:
^([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)$The current setup generation.
Required range:
1 <= x <= 2147483647The setup revision last read; a stale revision is refused.
Required range:
0 <= x <= 2147483647The setups to run.
Show child attributes
Show child attributes
Response
The workspace’s company setup and the hash of its saved company profile.
The workspace’s company setup and the hash of its saved company profile.
The company setup; null when the workspace has not started one.
Show child attributes
Show child attributes
The hash of the saved company profile. Send it as expectedProfileHash to confirm.
Only on a websiteOnboarding.confirmProfile answer: whether it started company research from the saved website. Absent on other commands and on replays of Confirm answers given before this field existed.
- Option 1
- Option 2
Show child attributes
Show child attributes
Was this page helpful?