{ "auth": { "bearer": [ { "key": "token", "type": "string", "value": "{{apiKey}}" } ], "type": "bearer" }, "event": [ { "listen": "prerequest", "script": { "exec": [ "if (!pm.collectionVariables.get('apiKey')) {", " throw new Error('Set the apiKey collection variable before sending requests.');", "}" ], "type": "text/javascript" } } ], "info": { "_postman_id": "22c61c81-0fcd-5468-89cf-1f4ba7e2541f", "description": "Generated from the canonical Blackpearl public OpenAPI contract. OpenAPI version 0.2.0; SHA-256 dceb0c0ef711088086da648c53024f0dc8e379fbbf569c3a2b4c0de77211737b. Set baseUrl and apiKey. Persist idempotencyKey while retrying an unchanged job-creation request.", "name": "Blackpearl Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": { "major": 0, "minor": 2, "patch": 0 } }, "item": [ { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"public_account_research_v1_account_research_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Research an account", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"analyze\": true,\n \"domain\": \"hubspot.com\",\n \"include_similar\": true\n}" }, "description": "Fetch one structured website-intelligence record for a company domain \u2014 identity, scale, market, digital presence, buying signals and any surfaced contacts. Synchronous: the record returns in the response. Each successful lookup meters one `prospect_research` request. Unknown domains return `404 account_not_found` unmetered \u2014 or set `analyze: true` to fetch and analyze the website on demand (one extra metered request). Set `include_similar: true` to add up to 10 lookalike companies from the similarity index.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "account-research" ], "raw": "{{baseUrl}}/v1/account-research" } }, "response": [] } ], "name": "API" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_account_coordination_assessment_v1_account_coordination_assessments_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Account Coordination Assessment", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"audience_id\": \"audience_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"company_domain\": \"Example company domain\",\n \"expected_audience_result_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_policy_version\": \"2026-07-13\",\n \"key\": \"example-key\",\n \"reason\": \"Example value\"\n}" }, "description": "Create Account Coordination Assessment. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "account-coordination-assessments" ], "raw": "{{baseUrl}}/v1/account-coordination-assessments" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_account_coordination_assessment_v1_account_coordination_assessments__assessment_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Account Coordination Assessment", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Account Coordination Assessment. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "account-coordination-assessments", ":assessment_id" ], "raw": "{{baseUrl}}/v1/account-coordination-assessments/:assessment_id", "variable": [ { "key": "assessment_id", "value": "" } ] } }, "response": [] } ], "name": "Account Coordination" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_audiences_v1_audience_snapshots_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Audiences", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Audiences. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audience-snapshots" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "cursor", "value": "" } ], "raw": "{{baseUrl}}/v1/audience-snapshots?limit={{limit}}&cursor={{cursor}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_audience_v1_audience_snapshots_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Audience", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"key\": \"example_key\",\n \"name\": \"Example value\",\n \"prospecting_job_id\": \"job_aaaaaaaaaaaaaaaaaaaaaaaa\"\n}" }, "description": "Create Audience. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audience-snapshots" ], "raw": "{{baseUrl}}/v1/audience-snapshots" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_audience_v1_audience_snapshots__audience_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Audience", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Audience. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audience-snapshots", ":audience_id" ], "raw": "{{baseUrl}}/v1/audience-snapshots/:audience_id", "variable": [ { "key": "audience_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"export_audience_csv_v1_audience_snapshots__audience_id__export_csv_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Export Audience Csv", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Export Audience Csv. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audience-snapshots", ":audience_id", "export.csv" ], "query": [ { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "review_status", "value": "pending" }, { "disabled": true, "key": "qualification_status", "value": "" }, { "disabled": true, "key": "enrichment_status", "value": "" }, { "disabled": true, "key": "outreach_state", "value": "" }, { "disabled": true, "key": "min_score", "value": "" }, { "disabled": true, "key": "has_evidence", "value": "" }, { "disabled": true, "key": "has_work_email", "value": "" }, { "disabled": true, "key": "prospect_id", "value": "" } ], "raw": "{{baseUrl}}/v1/audience-snapshots/:audience_id/export.csv?q={{q}}&review_status={{review_status}}&qualification_status={{qualification_status}}&enrichment_status={{enrichment_status}}&outreach_state={{outreach_state}}&min_score={{min_score}}&has_evidence={{has_evidence}}&has_work_email={{has_work_email}}&prospect_id={{prospect_id}}", "variable": [ { "key": "audience_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_audience_members_v1_audience_snapshots__audience_id__members_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Audience Members", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Audience Members. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audience-snapshots", ":audience_id", "members" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "review_status", "value": "pending" }, { "disabled": true, "key": "qualification_status", "value": "" }, { "disabled": true, "key": "enrichment_status", "value": "" }, { "disabled": true, "key": "outreach_state", "value": "" }, { "disabled": true, "key": "min_score", "value": "" }, { "disabled": true, "key": "has_evidence", "value": "" }, { "disabled": true, "key": "has_work_email", "value": "" }, { "disabled": true, "key": "prospect_id", "value": "" } ], "raw": "{{baseUrl}}/v1/audience-snapshots/:audience_id/members?limit={{limit}}&cursor={{cursor}}&q={{q}}&review_status={{review_status}}&qualification_status={{qualification_status}}&enrichment_status={{enrichment_status}}&outreach_state={{outreach_state}}&min_score={{min_score}}&has_evidence={{has_evidence}}&has_work_email={{has_work_email}}&prospect_id={{prospect_id}}", "variable": [ { "key": "audience_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"review_audience_members_v1_audience_snapshots__audience_id__reviews_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Review Audience Members", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"decision\": \"included\",\n \"member_ids\": [\n \"audmem_aaaaaaaaaaaaaaaaaaaaaaaa\"\n ],\n \"reason_code\": \"example_key\",\n \"review_key\": \"Example value\"\n}" }, "description": "Review Audience Members. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audience-snapshots", ":audience_id", "reviews" ], "raw": "{{baseUrl}}/v1/audience-snapshots/:audience_id/reviews", "variable": [ { "key": "audience_id", "value": "" } ] } }, "response": [] } ], "name": "Audience Snapshots" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_audience_v1_audiences_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Create and run an Audience", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"excluded_domains\": [\n \"existing-customer.example\"\n ],\n \"max_contacts_per_company\": 3,\n \"model\": \"default\",\n \"name\": \"North America RevOps leaders\",\n \"objective\": \"Find VP and director-level revenue operations leaders at B2B SaaS companies.\",\n \"playbooks_enabled\": false,\n \"product_description\": \"Revenue-intelligence software for enterprise sales teams.\",\n \"product_name\": \"Northstar Analytics\",\n \"target_size\": 100,\n \"website_url\": \"northstar.example\"\n}" }, "description": "Create a campaign and start its first asynchronous Audience cycle in one request. Use `Idempotency-Key` when retrying an ambiguous accepted request; matching retries replay the original response for 24 hours.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audiences" ], "raw": "{{baseUrl}}/v1/audiences" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_audience_candidates_v1_audiences__job_id__candidates_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Audience candidates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Read a cursor page of typed candidates for a completed Audience job. The job result is a compact summary; use this endpoint for candidate records.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "audiences", ":job_id", "candidates" ], "query": [ { "disabled": true, "key": "q", "value": "" }, { "disabled": true, "key": "sort", "value": "final_score" }, { "disabled": true, "key": "direction", "value": "desc" }, { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "cursor", "value": "" } ], "raw": "{{baseUrl}}/v1/audiences/:job_id/candidates?q={{q}}&sort={{sort}}&direction={{direction}}&limit={{limit}}&cursor={{cursor}}", "variable": [ { "key": "job_id", "value": "job_example" } ] } }, "response": [] } ], "name": "Audiences" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_brands_v1_brands_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List active brands", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List active Brand resources for the authenticated organization, including latest research state, guideline revision, and provenance source count. Internal branding snapshots are never returned.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "brands" ], "raw": "{{baseUrl}}/v1/brands" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_brand_v1_brands_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Research a brand and build its guideline", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"company_name\": \"Acme Corporation\",\n \"is_default\": false,\n \"key\": \"acme_corporation\",\n \"website_url\": \"https://acme.example\"\n}" }, "description": "Create a Brand resource, enqueue evidence-backed web research, and return its typed Brands job. Poll `GET /v1/jobs/{job_id}` until terminal, then read the versioned guideline from the result path. Send `Idempotency-Key` so an ambiguous retry replays the original response for 24 hours.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "brands" ], "raw": "{{baseUrl}}/v1/brands" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_brand_v1_brands__brand_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get a brand", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Read one organization-owned Brand resource and its latest research state without exposing raw provider data.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "brands", ":brand_id" ], "raw": "{{baseUrl}}/v1/brands/:brand_id", "variable": [ { "key": "brand_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_brand_guideline_v1_brands__brand_id__guideline_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get a standardized brand guideline", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Read the current immutable, hash-addressable guideline document with identity, foundations, audience, positioning, voice, messaging, visual rules, applications, governance, and research provenance.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "brands", ":brand_id", "guideline" ], "raw": "{{baseUrl}}/v1/brands/:brand_id/guideline", "variable": [ { "key": "brand_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"research_brand_v1_brands__brand_id__research_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Refresh a brand guideline from current web evidence", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Enqueue a new evidence-backed guideline revision for an existing active Brand. If research is already queued or running, return that active job instead of creating a duplicate.", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "brands", ":brand_id", "research" ], "raw": "{{baseUrl}}/v1/brands/:brand_id/research", "variable": [ { "key": "brand_id", "value": "" } ] } }, "response": [] } ], "name": "Brands" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_campaigns_v1_campaigns_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Audience campaigns", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List non-archived Audience campaigns in the API key's project, newest first. Pass `next_cursor` back as `cursor` to read the next page.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "cursor", "value": "" } ], "raw": "{{baseUrl}}/v1/campaigns?limit={{limit}}&cursor={{cursor}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_campaign_v1_campaigns_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Create an Audience campaign", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"excluded_domains\": [\n \"existing-customer.example\"\n ],\n \"max_contacts_per_company\": 3,\n \"model\": \"default\",\n \"name\": \"North America RevOps leaders\",\n \"objective\": \"Find VP and director-level revenue operations leaders at B2B SaaS companies.\",\n \"playbooks_enabled\": false,\n \"product_description\": \"Revenue-intelligence software for enterprise sales teams.\",\n \"product_name\": \"Northstar Analytics\",\n \"target_size\": 100,\n \"website_url\": \"northstar.example\"\n}" }, "description": "Save a typed Audience targeting specification for repeated cycles without immediately running it. Start a cycle with `POST /v1/campaigns/{campaign_id}/cycles`.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "raw": "{{baseUrl}}/v1/campaigns" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_campaign_v1_campaigns__campaign_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Retrieve an Audience campaign", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Return one typed Audience campaign when it belongs to the API key's project.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "variable": [ { "key": "campaign_id", "value": "camp_example" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"update_campaign_v1_campaigns__campaign_id__patch returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Update a campaign's GTM relations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{}" }, "description": "Update the organizing GTM half of a campaign: name, key, objective, status, metadata, and the brand/offer/playbook/message-template/document relations it sells with. Send an empty string for a relation field to clear it; omit a field to leave it unchanged. This does not run a cycle.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id" ], "raw": "{{baseUrl}}/v1/campaigns/:campaign_id", "variable": [ { "key": "campaign_id", "value": "camp_example" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_campaign_cycles_v1_campaigns__campaign_id__cycles_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Audience campaign cycles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List the most recent asynchronous Audience cycles for a campaign in descending creation order.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "cycles" ], "query": [ { "disabled": true, "key": "limit", "value": "20" } ], "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/cycles?limit={{limit}}", "variable": [ { "key": "campaign_id", "value": "camp_example" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"run_campaign_cycle_v1_campaigns__campaign_id__cycles_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Create an Audience campaign cycle", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Start one asynchronous Audience cycle for a saved campaign. Reusing `Idempotency-Key` with matching input within 24 hours returns the original cycle job rather than creating a duplicate.", "header": [ { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":campaign_id", "cycles" ], "raw": "{{baseUrl}}/v1/campaigns/:campaign_id/cycles", "variable": [ { "key": "campaign_id", "value": "camp_example" } ] } }, "response": [] } ], "name": "Campaigns" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"capabilities_v1_capabilities_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List enabled capabilities", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List the public capabilities enabled for the API key's organization. Use `key` values when interpreting usage rollups and capability-specific workflows.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "capabilities" ], "raw": "{{baseUrl}}/v1/capabilities" } }, "response": [] } ], "name": "Capabilities" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"connection_list_v1_connections_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Connection List", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Connection List. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "connections" ], "raw": "{{baseUrl}}/v1/connections" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"connector_catalog_list_v1_connectors_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Connector Catalog List", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Connector Catalog List. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "connectors" ], "raw": "{{baseUrl}}/v1/connectors" } }, "response": [] } ], "name": "Connectors" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_data_intake_specifications_v1_data_intake_specifications_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Data Intake Specifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Data Intake Specifications. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "data-intake-specifications" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/data-intake-specifications?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_data_intake_specification_v1_data_intake_specifications_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Data Intake Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"deduplication\": {\n \"match_keys\": [\n \"source_record_id\"\n ]\n },\n \"expected_policy_version\": \"2026-07-13\",\n \"fields\": [\n \"source_record_id\",\n \"source_record_id\"\n ],\n \"key\": \"example-key\",\n \"purpose\": \"account_discovery\",\n \"reason\": \"Example value\",\n \"retention_days\": 1,\n \"selection\": {\n \"max_records\": 1\n },\n \"source\": {\n \"source\": \"overture_places\",\n \"version\": \"2026-07-15.1\"\n }\n}" }, "description": "Create Data Intake Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "data-intake-specifications" ], "raw": "{{baseUrl}}/v1/data-intake-specifications" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_data_intake_specification_v1_data_intake_specifications__specification_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Data Intake Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Data Intake Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "data-intake-specifications", ":specification_id" ], "raw": "{{baseUrl}}/v1/data-intake-specifications/:specification_id", "variable": [ { "key": "specification_id", "value": "" } ] } }, "response": [] } ], "name": "Data Intake" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_company_dossier_specifications_v1_company_dossier_specifications_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Company Dossier Specifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Company Dossier Specifications. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-dossier-specifications" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/company-dossier-specifications?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_company_dossier_specification_v1_company_dossier_specifications_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Company Dossier Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"collection_budget\": {\n \"maximum_concurrent_requests\": 1,\n \"maximum_evidence_items\": 1,\n \"maximum_map_requests\": 1,\n \"maximum_model_input_chars\": 1000,\n \"maximum_model_requests\": 1,\n \"maximum_provider_credits\": 1,\n \"maximum_search_requests\": 0,\n \"maximum_search_results_per_query\": 1,\n \"maximum_site_pages\": 1,\n \"maximum_wall_time_seconds\": 30,\n \"request_timeout_seconds\": 5\n },\n \"connection\": {\n \"connection_id\": \"conn_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_credentials_version\": 1,\n \"expected_manifest_version\": \"2026-07-14\"\n },\n \"expected_policy_version\": \"2026-07-15\",\n \"key\": \"example-key\",\n \"purpose\": \"company_research\",\n \"reason\": \"Example value\",\n \"sections\": [\n \"company_profile\"\n ],\n \"target\": {\n \"domain\": \"Example domain\"\n }\n}" }, "description": "Create Company Dossier Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-dossier-specifications" ], "raw": "{{baseUrl}}/v1/company-dossier-specifications" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_company_dossier_specification_v1_company_dossier_specifications__specification_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Company Dossier Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Company Dossier Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-dossier-specifications", ":specification_id" ], "raw": "{{baseUrl}}/v1/company-dossier-specifications/:specification_id", "variable": [ { "key": "specification_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_document_job_v1_documents_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Create a Documents job", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"brand\": \"northstar\",\n \"brief\": \"A first-meeting sales proposal for Acme Corporation's RevOps team: lead with their pipeline-visibility pains, map our onboarding time-to-value, and close with a 90-day rollout plan and pricing summary.\",\n \"document_type\": \"proposal\",\n \"external_ref\": \"crm-account-123\",\n \"format\": \"docx\",\n \"offer\": \"analytics_suite\",\n \"target_domain\": \"acme.example\",\n \"template_urls\": [\n \"https://cdn.example/templates/enterprise-proposal.docx\"\n ],\n \"title\": \"Acme Corporation proposal\"\n}" }, "description": "Generate finished sales-collateral files \u2014 proposals, playbooks, decks, GTM strategies, reports or one-pagers as `.pptx`/`.docx`/`.pdf` \u2014 from a `brief`, driven by the Doc Maker managed agent. The platform composes the selling context from your Brand Pack (the organization's default brand unless `brand` selects another profile; the brand must have a completed guideline or the request fails with `409 brand_guideline_missing`) plus the optional `offer`, and the agent follows up to three reference `template_urls`. Poll `GET /v1/jobs/{job_id}` until the job reaches a terminal state, then download each referenced file with `GET /v1/documents/{job_id}/files/{file_id}`. Send `Idempotency-Key` so an ambiguous request can safely replay its original response for 24 hours.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents" ], "raw": "{{baseUrl}}/v1/documents" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"download_document_job_file_v1_documents__job_id__files__file_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Download a document file", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Download the raw bytes of one collateral file produced by a succeeded Documents job. File identifiers, filenames, formats and sizes are listed in the job result's `files` array. The response body is the file itself with a format-specific `Content-Type` (PPTX, DOCX or PDF) and a `Content-Disposition: attachment` filename; unknown formats stream as `application/octet-stream`. Files share the job's 30-day retention window.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "documents", ":job_id", "files", ":file_id" ], "raw": "{{baseUrl}}/v1/documents/:job_id/files/:file_id", "variable": [ { "key": "job_id", "value": "job_example" }, { "key": "file_id", "value": "" } ] } }, "response": [] } ], "name": "Documents" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_enrichment_specifications_v1_enrichment_specifications_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Enrichment Specifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Enrichment Specifications. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "enrichment-specifications" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/enrichment-specifications?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_enrichment_specification_v1_enrichment_specifications_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Enrichment Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"audience_id\": \"audience_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_audience_result_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_policy_version\": \"2026-07-13\",\n \"fields\": [\n \"company_description\"\n ],\n \"key\": \"example-key\",\n \"reason\": \"Example value\",\n \"selection\": {\n \"mode\": \"included\"\n }\n}" }, "description": "Create Enrichment Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "enrichment-specifications" ], "raw": "{{baseUrl}}/v1/enrichment-specifications" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_enrichment_specification_v1_enrichment_specifications__specification_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Enrichment Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Enrichment Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "enrichment-specifications", ":specification_id" ], "raw": "{{baseUrl}}/v1/enrichment-specifications/:specification_id", "variable": [ { "key": "specification_id", "value": "" } ] } }, "response": [] } ], "name": "Enrichment" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_job_v1_jobs__job_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Retrieve an asynchronous job", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Retrieve a job in the API key's project. The `type` discriminator selects the matching Playbooks or Audiences input and result shape.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "jobs", ":job_id" ], "raw": "{{baseUrl}}/v1/jobs/:job_id", "variable": [ { "key": "job_id", "value": "job_example" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_prospecting_continuation_v1_jobs__parent_job_id__continuations_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 202]);", "});" ], "type": "text/javascript" } } ], "name": "Create Prospecting Continuation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"additional_prospect_limit\": 1,\n \"continuation_key\": \"example-key\"\n}" }, "description": "Create Prospecting Continuation. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "jobs", ":parent_job_id", "continuations" ], "raw": "{{baseUrl}}/v1/jobs/:parent_job_id/continuations", "variable": [ { "key": "parent_job_id", "value": "" } ] } }, "response": [] } ], "name": "Jobs" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_message_template_revisions_v1_message_template_revisions_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Message Template Revisions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Message Template Revisions. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "message-template-revisions" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" }, { "disabled": true, "key": "template_key", "value": "" }, { "disabled": true, "key": "language", "value": "" } ], "raw": "{{baseUrl}}/v1/message-template-revisions?limit={{limit}}&offset={{offset}}&template_key={{template_key}}&language={{language}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_message_template_revision_v1_message_template_revisions_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Message Template Revision", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"body\": [\n {\n \"content\": [\n {\n \"kind\": \"text\",\n \"text\": \"Kia ora.\"\n }\n ],\n \"kind\": \"paragraph\"\n },\n {\n \"kind\": \"opt_out_notice\"\n }\n ],\n \"channel\": \"email\",\n \"expected_policy_version\": \"2026-07-13\",\n \"expected_previous_template_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"language\": \"en-nz\",\n \"name\": \"First-touch introduction\",\n \"purpose\": \"gtm_outreach\",\n \"reason\": \"Publish a reviewed structural template for exact rendering.\",\n \"revision_number\": 2,\n \"subject\": [\n {\n \"kind\": \"text\",\n \"text\": \"A practical idea for \"\n },\n {\n \"key\": \"contact.firstname\",\n \"kind\": \"variable\"\n }\n ],\n \"template_key\": \"first-touch\",\n \"variables\": [\n {\n \"classification\": \"recipient_personal\",\n \"key\": \"contact.firstname\",\n \"max_length\": 50,\n \"required\": true\n }\n ]\n}" }, "description": "Create Message Template Revision. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "message-template-revisions" ], "raw": "{{baseUrl}}/v1/message-template-revisions" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"generate_message_template_revision_v1_message_template_revisions_generate_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Generate an immutable message-template revision", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"audience\": \"Example audience\",\n \"desired_next_step\": \"Example desired next step\",\n \"name\": \"Example name\",\n \"objective\": \"Example objective\",\n \"reason\": \"Example value\",\n \"template_key\": \"example-key\"\n}" }, "description": "Start a bounded OpenAI Responses job from approved GTM context. The server converts only allowlisted placeholders into the closed structural template format, applies the published quality gate, persists the next immutable revision, and never enqueues or sends a message.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "message-template-revisions", "generate" ], "raw": "{{baseUrl}}/v1/message-template-revisions/generate" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_message_template_revision_v1_message_template_revisions__revision_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Message Template Revision", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Message Template Revision. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "message-template-revisions", ":revision_id" ], "raw": "{{baseUrl}}/v1/message-template-revisions/:revision_id", "variable": [ { "key": "revision_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"generate_prospect_message_v1_message_template_revisions__revision_id__prospect_message_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Personalize an approval-only message for a retained prospect", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"prospect_id\": \"Example value\",\n \"prospecting_job_id\": \"job_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"reason\": \"Example value\"\n}" }, "description": "Verify platform policy, suppression, identity, qualification, and retained evidence for one prospect from an unexpired succeeded Prospecting job, then deterministically render the selected immutable revision. Personalization makes no provider call, and passing copy remains an approval artifact with no send authority.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "message-template-revisions", ":revision_id", "prospect-message" ], "raw": "{{baseUrl}}/v1/message-template-revisions/:revision_id/prospect-message", "variable": [ { "key": "revision_id", "value": "" } ] } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"render_message_template_revision_v1_message_template_revisions__revision_id__render_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Render Message Template Revision", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"expected_policy_version\": \"2026-07-13\",\n \"expected_template_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"fail_closed_on_error\": true,\n \"reference\": \"example-key\",\n \"values\": {}\n}" }, "description": "Render Message Template Revision. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "message-template-revisions", ":revision_id", "render" ], "raw": "{{baseUrl}}/v1/message-template-revisions/:revision_id/render", "variable": [ { "key": "revision_id", "value": "" } ] } }, "response": [] } ], "name": "Message Templates" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_offers_v1_offers_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Offers", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List the authenticated organization's Offer catalog, optionally including archived Offers.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "offers" ], "query": [ { "disabled": true, "key": "include_archived", "value": "false" } ], "raw": "{{baseUrl}}/v1/offers?include_archived={{include_archived}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_offer_v1_offers_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([201]);", "});" ], "type": "text/javascript" } } ], "name": "Create an Offer", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"brand_profile_id\": \"Example brand profile id\",\n \"name\": \"Example name\"\n}" }, "description": "Create structured selling context under an active Brand. Offer creation performs no research, generation, provider request, pricing calculation, or outbound action.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "offers" ], "raw": "{{baseUrl}}/v1/offers" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_offer_v1_offers__offer_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Retrieve an Offer", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Return one Offer when it belongs to the authenticated organization.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "offers", ":offer_id" ], "raw": "{{baseUrl}}/v1/offers/:offer_id", "variable": [ { "key": "offer_id", "value": "" } ] } }, "response": [] } ], "name": "Offers" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_outcomes_v1_outcomes_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Outcomes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Outcomes. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "outcomes" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "type", "value": "qualification_approved" }, { "disabled": true, "key": "classification", "value": "preference" }, { "disabled": true, "key": "subject_kind", "value": "prospect" }, { "disabled": true, "key": "prospecting_job_id", "value": "" }, { "disabled": true, "key": "prospect_id", "value": "" }, { "disabled": true, "key": "account_domain", "value": "" }, { "disabled": true, "key": "campaign_id", "value": "camp_example" }, { "disabled": true, "key": "offer_id", "value": "" } ], "raw": "{{baseUrl}}/v1/outcomes?limit={{limit}}&cursor={{cursor}}&type={{type}}&classification={{classification}}&subject_kind={{subject_kind}}&prospecting_job_id={{prospecting_job_id}}&prospect_id={{prospect_id}}&account_domain={{account_domain}}&campaign_id={{campaign_id}}&offer_id={{offer_id}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_outcome_v1_outcomes_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Outcome", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"external_event_id\": \"Example value\",\n \"occurred_at\": \"2026-07-16T00:00:00Z\",\n \"source\": \"example_key\",\n \"type\": \"qualification_approved\"\n}" }, "description": "Create Outcome. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "outcomes" ], "raw": "{{baseUrl}}/v1/outcomes" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"outcome_insights_v1_outcomes_insights_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Outcome Insights", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Outcome Insights. This is a ga operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "outcomes", "insights" ], "query": [ { "disabled": true, "key": "group_by", "value": "campaign" }, { "disabled": true, "key": "since", "value": "" }, { "disabled": true, "key": "until", "value": "" }, { "disabled": true, "key": "campaign_id", "value": "camp_example" }, { "disabled": true, "key": "offer_id", "value": "" } ], "raw": "{{baseUrl}}/v1/outcomes/insights?group_by={{group_by}}&since={{since}}&until={{until}}&campaign_id={{campaign_id}}&offer_id={{offer_id}}" } }, "response": [] } ], "name": "Outcomes" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_playbook_templates_v1_playbook_templates_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List stage-aware Playbook templates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Return the versioned curated template catalog. Optionally filter by one shared deal stage before binding a template to a Playbooks request.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbook-templates" ], "query": [ { "disabled": true, "key": "stage", "value": "" } ], "raw": "{{baseUrl}}/v1/playbook-templates?stage={{stage}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_playbook_v1_playbooks_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Create a Playbooks job", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"anchor_company\": \"Northstar Analytics\",\n \"model\": \"default\",\n \"product_info\": \"Revenue-intelligence software for enterprise sales teams.\",\n \"sections\": [\n \"summary\",\n \"value_props\",\n \"personas\",\n \"objections\"\n ],\n \"target_company_domain\": \"acme.example\",\n \"tone\": \"consultative\"\n}" }, "description": "Validate a target company, enqueue a Playbooks generation job, and return its typed job response. Poll `GET /v1/jobs/{job_id}` until it reaches a terminal state. Send `Idempotency-Key` so an ambiguous request can safely replay its original response for 24 hours.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks" ], "raw": "{{baseUrl}}/v1/playbooks" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_playbook_document_v1_playbooks__job_id__document_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Retrieve the rendered playbook document", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Return the fully rendered, self-contained HTML playbook for a succeeded Playbooks job. Only available when the generation backend produced a rendered document (`result.document_url` is non-null).", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks", ":job_id", "document" ], "raw": "{{baseUrl}}/v1/playbooks/:job_id/document", "variable": [ { "key": "job_id", "value": "job_example" } ] } }, "response": [] } ], "name": "Playbooks" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_professional_network_specifications_v1_professional_network_specifications_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Professional Network Specifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Professional Network Specifications. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "professional-network-specifications" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/professional-network-specifications?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_professional_network_specification_v1_professional_network_specifications_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Professional Network Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"audience_id\": \"audience_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"connection\": {\n \"connection_id\": \"conn_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_credentials_version\": 1,\n \"expected_manifest_version\": \"2026-07-14\"\n },\n \"display_components\": [\n \"profile_summary\"\n ],\n \"expected_audience_result_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_policy_version\": \"2026-07-13\",\n \"key\": \"example-key\",\n \"purpose\": \"crm_sync\",\n \"reason\": \"Example value\",\n \"selection\": {\n \"mode\": \"included\"\n }\n}" }, "description": "Create Professional Network Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "professional-network-specifications" ], "raw": "{{baseUrl}}/v1/professional-network-specifications" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_professional_network_specification_v1_professional_network_specifications__specification_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Professional Network Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Professional Network Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "professional-network-specifications", ":specification_id" ], "raw": "{{baseUrl}}/v1/professional-network-specifications/:specification_id", "variable": [ { "key": "specification_id", "value": "" } ] } }, "response": [] } ], "name": "Professional Network" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_prospect_research_specifications_v1_prospect_research_specifications_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Prospect Research Specifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Prospect Research Specifications. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "prospect-research-specifications" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/prospect-research-specifications?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_prospect_research_specification_v1_prospect_research_specifications_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Prospect Research Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"audience_id\": \"audience_aaaaaaaaaaaaaaaaaaaaaaaa\",\n \"collection_budget\": {\n \"max_agent_tool_calls_per_member\": 0,\n \"max_evidence_items_per_member\": 1,\n \"max_model_input_chars_per_member\": 1000,\n \"max_model_requests_per_member\": 1,\n \"max_provider_requests_per_member\": 0\n },\n \"expected_audience_result_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"expected_policy_version\": \"2026-07-15\",\n \"key\": \"example-key\",\n \"lenses\": [\n \"business_priorities\"\n ],\n \"purpose\": \"qualification\",\n \"reason\": \"Example value\",\n \"selection\": {\n \"mode\": \"included\"\n }\n}" }, "description": "Create Prospect Research Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "prospect-research-specifications" ], "raw": "{{baseUrl}}/v1/prospect-research-specifications" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_prospect_research_specification_v1_prospect_research_specifications__specification_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Prospect Research Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Prospect Research Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "prospect-research-specifications", ":specification_id" ], "raw": "{{baseUrl}}/v1/prospect-research-specifications/:specification_id", "variable": [ { "key": "specification_id", "value": "" } ] } }, "response": [] } ], "name": "Prospect Research" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_prospecting_job_v1_prospects_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([202]);", "});" ], "type": "text/javascript" } } ], "name": "Create a Prospecting job", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"campaign_name\": \"Example campaign name\",\n \"objective\": \"Example objective\",\n \"product_info\": \"Example product info\"\n}" }, "description": "Discover and qualify evidence-backed prospects for an audience specification. Poll `GET /v1/jobs/{job_id}` until the job reaches a terminal state.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "prospects" ], "raw": "{{baseUrl}}/v1/prospects" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"prospecting_run_events_v1_prospects__job_id__events_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Stream a prospecting run's live thread", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Poll the append-only event log of an agentic prospecting run (agent status, streamed messages, discovered leads). Pass the returned `next_after_seq` back as `after_seq` to fetch only newer events.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "prospects", ":job_id", "events" ], "query": [ { "disabled": true, "key": "after_seq", "value": "0" }, { "disabled": true, "key": "limit", "value": "20" } ], "raw": "{{baseUrl}}/v1/prospects/:job_id/events?after_seq={{after_seq}}&limit={{limit}}", "variable": [ { "key": "job_id", "value": "job_example" } ] } }, "response": [] } ], "name": "Prospecting" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_qualification_policies_v1_qualification_policies_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Qualification Policies", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Qualification Policies. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "qualification-policies" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/qualification-policies?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_qualification_policy_v1_qualification_policies_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Qualification Policy", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"dimensions\": [\n {\n \"dimension\": \"industry_match\",\n \"weight_percent\": 0\n },\n {\n \"dimension\": \"industry_match\",\n \"weight_percent\": 0\n },\n {\n \"dimension\": \"industry_match\",\n \"weight_percent\": 0\n },\n {\n \"dimension\": \"industry_match\",\n \"weight_percent\": 0\n },\n {\n \"dimension\": \"industry_match\",\n \"weight_percent\": 0\n }\n ],\n \"expected_policy_version\": \"2026-07-13\",\n \"key\": \"example-key\",\n \"reason\": \"Example value\",\n \"target\": {\n \"industries\": [\n \"ai_ml\"\n ],\n \"seniorities\": [\n \"c_suite\"\n ]\n }\n}" }, "description": "Create Qualification Policy. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "qualification-policies" ], "raw": "{{baseUrl}}/v1/qualification-policies" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_qualification_policy_v1_qualification_policies__qualification_policy_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Qualification Policy", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Qualification Policy. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "qualification-policies", ":qualification_policy_id" ], "raw": "{{baseUrl}}/v1/qualification-policies/:qualification_policy_id", "variable": [ { "key": "qualification_policy_id", "value": "" } ] } }, "response": [] } ], "name": "Qualification Policies" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"list_site_audit_specifications_v1_site_audit_specifications_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "List Site Audit Specifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "List Site Audit Specifications. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "site-audit-specifications" ], "query": [ { "disabled": true, "key": "limit", "value": "20" }, { "disabled": true, "key": "offset", "value": "0" } ], "raw": "{{baseUrl}}/v1/site-audit-specifications?limit={{limit}}&offset={{offset}}" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"create_site_audit_specification_v1_site_audit_specifications_post returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200, 201]);", "});" ], "type": "text/javascript" } } ], "name": "Create Site Audit Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"check_profile\": \"aeo_site_readiness_29\",\n \"expected_policy_version\": \"2026-07-13\",\n \"key\": \"example-key\",\n \"reason\": \"Example value\",\n \"target\": {\n \"authorization_attested\": true,\n \"domain\": \"Example domain\",\n \"relationship\": \"owned_or_operated\"\n }\n}" }, "description": "Create Site Audit Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "site-audit-specifications" ], "raw": "{{baseUrl}}/v1/site-audit-specifications" } }, "response": [] }, { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"get_site_audit_specification_v1_site_audit_specifications__specification_id__get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Get Site Audit Specification", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Get Site Audit Specification. This is a preview operation scoped to the authenticated project or organization as documented by its response schema.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "site-audit-specifications", ":specification_id" ], "raw": "{{baseUrl}}/v1/site-audit-specifications/:specification_id", "variable": [ { "key": "specification_id", "value": "" } ] } }, "response": [] } ], "name": "Site Intelligence" }, { "item": [ { "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"usage_v1_usage_get returns a documented success\", function () {", " pm.expect(pm.response.code).to.be.oneOf([200]);", "});" ], "type": "text/javascript" } } ], "name": "Retrieve project usage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "description": "Return month-to-date usage and prepaid-credit information for the API key's project.", "header": [ { "disabled": true, "key": "X-Request-ID", "value": "postman-{{$guid}}" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ], "raw": "{{baseUrl}}/v1/usage" } }, "response": [] } ], "name": "Usage" } ], "variable": [ { "key": "baseUrl", "type": "string", "value": "http://localhost:8400" }, { "key": "apiKey", "type": "string", "value": "" }, { "key": "idempotencyKey", "type": "string", "value": "playbook-postman-change-me" }, { "key": "openapiVersion", "type": "string", "value": "0.2.0" }, { "key": "openapiSha256", "type": "string", "value": "dceb0c0ef711088086da648c53024f0dc8e379fbbf569c3a2b4c0de77211737b" } ], "x-blackpearl-operation-ids": [ "capabilities_v1_capabilities_get", "connection_list_v1_connections_get", "connector_catalog_list_v1_connectors_get", "create_account_coordination_assessment_v1_account_coordination_assessments_post", "create_audience_v1_audience_snapshots_post", "create_audience_v1_audiences_post", "create_brand_v1_brands_post", "create_campaign_v1_campaigns_post", "create_company_dossier_specification_v1_company_dossier_specifications_post", "create_data_intake_specification_v1_data_intake_specifications_post", "create_document_job_v1_documents_post", "create_enrichment_specification_v1_enrichment_specifications_post", "create_message_template_revision_v1_message_template_revisions_post", "create_offer_v1_offers_post", "create_outcome_v1_outcomes_post", "create_playbook_v1_playbooks_post", "create_professional_network_specification_v1_professional_network_specifications_post", "create_prospect_research_specification_v1_prospect_research_specifications_post", "create_prospecting_continuation_v1_jobs__parent_job_id__continuations_post", "create_prospecting_job_v1_prospects_post", "create_qualification_policy_v1_qualification_policies_post", "create_site_audit_specification_v1_site_audit_specifications_post", "download_document_job_file_v1_documents__job_id__files__file_id__get", "export_audience_csv_v1_audience_snapshots__audience_id__export_csv_get", "generate_message_template_revision_v1_message_template_revisions_generate_post", "generate_prospect_message_v1_message_template_revisions__revision_id__prospect_message_post", "get_account_coordination_assessment_v1_account_coordination_assessments__assessment_id__get", "get_audience_v1_audience_snapshots__audience_id__get", "get_brand_guideline_v1_brands__brand_id__guideline_get", "get_brand_v1_brands__brand_id__get", "get_campaign_v1_campaigns__campaign_id__get", "get_company_dossier_specification_v1_company_dossier_specifications__specification_id__get", "get_data_intake_specification_v1_data_intake_specifications__specification_id__get", "get_enrichment_specification_v1_enrichment_specifications__specification_id__get", "get_job_v1_jobs__job_id__get", "get_message_template_revision_v1_message_template_revisions__revision_id__get", "get_offer_v1_offers__offer_id__get", "get_playbook_document_v1_playbooks__job_id__document_get", "get_professional_network_specification_v1_professional_network_specifications__specification_id__get", "get_prospect_research_specification_v1_prospect_research_specifications__specification_id__get", "get_qualification_policy_v1_qualification_policies__qualification_policy_id__get", "get_site_audit_specification_v1_site_audit_specifications__specification_id__get", "list_audience_candidates_v1_audiences__job_id__candidates_get", "list_audience_members_v1_audience_snapshots__audience_id__members_get", "list_audiences_v1_audience_snapshots_get", "list_brands_v1_brands_get", "list_campaign_cycles_v1_campaigns__campaign_id__cycles_get", "list_campaigns_v1_campaigns_get", "list_company_dossier_specifications_v1_company_dossier_specifications_get", "list_data_intake_specifications_v1_data_intake_specifications_get", "list_enrichment_specifications_v1_enrichment_specifications_get", "list_message_template_revisions_v1_message_template_revisions_get", "list_offers_v1_offers_get", "list_outcomes_v1_outcomes_get", "list_playbook_templates_v1_playbook_templates_get", "list_professional_network_specifications_v1_professional_network_specifications_get", "list_prospect_research_specifications_v1_prospect_research_specifications_get", "list_qualification_policies_v1_qualification_policies_get", "list_site_audit_specifications_v1_site_audit_specifications_get", "outcome_insights_v1_outcomes_insights_get", "prospecting_run_events_v1_prospects__job_id__events_get", "public_account_research_v1_account_research_post", "render_message_template_revision_v1_message_template_revisions__revision_id__render_post", "research_brand_v1_brands__brand_id__research_post", "review_audience_members_v1_audience_snapshots__audience_id__reviews_post", "run_campaign_cycle_v1_campaigns__campaign_id__cycles_post", "update_campaign_v1_campaigns__campaign_id__patch", "usage_v1_usage_get" ] }