Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact’s place in THIS sequence, now stopped.
Answer what the action would do, exactly as the real call answers it, and change nothing.
Body
application/json
Where Move to another sequence should put the contact.
target_sequence_id
string<uuid>
required
The sequence to move the contact to. It must send to the same table.
Response
Successful Response
bounced
boolean
required
company_key
string | null
required
created_at
string<date-time>
required
current_step_id
string<uuid> | null
required
due_at
string<date-time> | null
required
email
string | null
required
id
string<uuid>
required
record_id
string<uuid>
required
replied_at
string<date-time> | null
required
status
enum<string>
required
Where one contact stands in one sequence.
ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the
in-flight guard between claim and outcome. PAUSED is a deliberate
per-contact hold: unclaimable because the tick claims strictly on ACTIVE,
yet still LIVE. It keeps its step and its one-live-sequence slot, and a
compliance stop (reply, unsubscribe) reaches it. Everything else is
settled: COMPLETED walked off the end; STOPPED was halted (reply,
unsubscribe, bounce, manual, company pause); FAILED is terminal;
SUPPRESSED was on the do-not-contact list;
SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the
reason visible in the grid.
A contact the workspace's recontact rule refuses is STOPPED with
StopReason.COOLDOWN. There is deliberately no held state: a cooldown
settles a contact rather than parking them, so nothing here waits on a date
and nothing lets itself out later.
AWAITING_ACTION is a contact parked behind a task that needs a
person or a channel, modelled on PAUSED: live, keeps its step and its
one-live-sequence slot, unclaimable because the tick claims strictly on
ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by
hand: only the outreach-task sweep does, once the task it waits on is
decided or delivered. Deliberately not "awaiting approval": an AUTO-mode
LinkedIn park is waiting for a browser rather than for anyone's approval,
and this value is the word the Contacts tab shows for both.
PENDING is a draft's roster: in, standing on a step, and NOT live. Binding
an audience enrols on the spot so the Contacts tab can show who is in, but
a sequence nobody has launched must not hold anybody's one-live-sequence
slot, or a second sequence written for the same people skips them all.
uq_sequence_enrolment_one_live leaves PENDING out, the tick never
claims it, and launch turns each row ACTIVE, settling the ones another
sequence took meanwhile as SKIPPED_DUPLICATE.
Available options:
pending,
active,
claimed,
paused,
awaiting_action,
completed,
stopped,
failed,
suppressed,
skipped_duplicate
stop_reason
enum<string> | null
required
Available options:
reply,
unsubscribe,
do_not_contact,
bounce,
manual,
company_reply,
row_left_audience,
row_left_paused,
step_removed,
removed,
cooldown,
rejected,
mailbox_removed,
unread_reply,
declined,
trashed,
trashed_paused
updated_at
string<date-time>
required
browser_outcome
ContactBrowserOutcomeReadSchema · object | null
The outcome the contact's latest settled Browser use run of this journey took, as the run settled on it: the Audience tab's Outcome column. Null until a run of theirs settles on one.
Show child attributes
contact_company
string | null
Their company, from whichever column of the audience row holds one.
contact_name
string | null
The person's name from their audience row: a full-name column where filled, else the given and family names joined. Null when the table names nobody.
contact_number
integer
default:0
This contact's ordinal within the sequence, from 1. A label of last resort, for a contact with neither an address nor a LinkedIn profile.
contact_title
string | null
Their job title, from whichever column of the audience row holds one.
cooldown_by_sequence
HeldBySequenceReadSchema · object | null
On a contact the cooldown stopped (stop_reason cooldown): the other sequence of this workspace whose touch at last_contacted_at the stop is measured from. Null when that touch is older than the clock knowing its sequence, or the sequence is gone or in Trash.
Show child attributes
cooldown_starts_at
string<date-time> | null
When a contact who starts on their own does, on a running sequence: the day the cooldown ends, or now once it has. Null on a paused sequence, where they start when it resumes, and for anyone who waits for a person.
cooldown_starts_by_itself
boolean
default:false
On a contact the cooldown stopped: true when they start on their own once it ends (this sequence is running or paused, nothing it sent reached them, and nothing else keeps them stopped). False means they stay stopped until a person resumes them.
decides_at
string<date-time> | null
For a contact on a condition that waits (Email bounced?, or an older Replied? or Accepted? check), or waiting for a connection request's answer: when the branch is decided. On a request it is when its answer window closes; in the past, the window is over and one more reading decides.
failure_code
enum<string> | null
Which kind of failure stopped a failed contact, where it changes what Retry does: connected_before_withdraw (a Withdraw found them already connected; nothing to retry, so no Retry is offered) or invite_look_unreadable (the look at their profile could not tell whether they accepted; Retry looks again), or missing_values (a Browser use step's goal reads a value their row has none for, so it never ran and charged nothing; Retry runs it once the value is filled in, and leaves them failed while it is empty: see missing_values). Null for every other failure and status.
Available options:
connected_before_withdraw,
invite_look_unreadable,
missing_values
failure_reason
string | null
Why a failed contact stopped, in a sentence: for a LinkedIn step, the browser's own reason. The status cell says only Failed; this is the why. Retry runs the same step again. Null on every other status.
held_by_sequence
HeldBySequenceReadSchema · object | null
On a contact skipped because they are in another live sequence (status skipped_duplicate): that sequence of this workspace, by id and name. Null for every other status, and once nothing holds the contact, which is when the next sync takes them in.
Show child attributes
hold_reason
enum<string> | null
Why the send path pushed this contact's next attempt out to due_at. Set only on an active contact whose due_at is still ahead. 'window' also covers a contact due on one of the sending window's openings, whoever scheduled them.
Available options:
window,
approved_window,
daily_cap,
no_mailbox,
pacing,
agent_unavailable,
no_message,
agent_writing,
agent_queued,
approval_queued,
mailbox_waiting,
no_linkedin_account,
confirming_send,
email_check,
out_of_office,
browser_queued,
browser_running,
browser_unavailable
invited_at
string<date-time> | null
When the connection request this contact stands on went out, or was first seen already pending: set while they wait for its answer (and kept through a pause or a stop). Null on every other step, and on a completed contact.
last_contacted_at
string<date-time> | null
The touch a cooldown stop is measured from. The sequence that made it is cooldown_by_sequence.
last_step_at
string<date-time> | null
When that step ran.
last_step_id
string<uuid> | null
The step this contact last actually ran. Not the step before current_step_id: on a branching graph those are different steps.
linkedin_queue
enum<string> | null
Set beside waiting_on 'linkedin': where the contact's step stands in the sending account's line. 'running' is in a browser now; 'queued' is in line (see linkedin_steps_ahead and linkedin_starts_at); the rest say why the line is not moving for it: the sequence's sending hours shut in the sender's timezone ('outside_window'), a daily or weekly limit for its kind, no browser checked in for fifteen minutes, LinkedIn asking to verify the account, or the account disconnected.
Available options:
running,
queued,
checking_replies,
outside_window,
daily_limit,
weekly_limit,
kind_disabled,
browser_offline,
verify_account,
disconnected
linkedin_resets_at
string<date-time> | null
For a step held by a daily or weekly limit, when the limit it waits on resets (midnight in the sender's timezone). Null otherwise.
linkedin_starts_at
string<date-time> | null
When the step is expected to start, simulated the way the account's governor hands steps out: the next gap is exact, later gaps are the account's time between steps widened by the average jitter, and a step held by a daily or weekly limit starts after that limit resets. Null where no time can be named.
linkedin_steps_ahead
integer | null
For a queued step, how many of the account's steps run before it.
linkedin_url
string | null
mailbox_address
string | null
The address this sequence emails the contact from. Within one sequence a contact is only ever emailed from the mailbox that first emailed them there; another sequence starts fresh. Null until this sequence has emailed them.
mailbox_issue
enum<string> | null
Why that mailbox cannot send for this sequence, set while it is what stops the contact (stop_reason mailbox_removed: deleted, not_on_sequence) or holds them (hold_reason mailbox_waiting: disconnected, no_sender).
Available options:
deleted,
not_on_sequence,
disconnected,
no_sender
missing_values
string[] | null
For a contact failed with failure_code missing_values: the values their Browser use step's goal reads that are still empty on their row now, in the goal's order. Empty once all are filled in, when Retry runs the step. Null for every other contact.
reachable
boolean
default:true
Whether any channel this sequence's steps use can reach the contact: an email address for an email step, a LinkedIn profile URL for a LinkedIn one. A sequence with no sending step yet counts both.
row_deleted
boolean
default:false
The contact's row is no longer on the audience table: it was deleted. A contact who Left the audience with this false left the view the sequence follows instead.
status_word
string | null
The contact's status in the one word every surface says it in, as the Audience tab's chip reads: Not started, In progress, Scheduled, Daily limit, Weekly limit, Waiting for reply, Waiting for acceptance, Queued to write, Queued for approval, Writing, Writing delayed, Verifying email, Waiting for browser, Browsing, Browser unavailable, Approved, Limit at zero, No mailbox, No message, Browser offline, Verify account, LinkedIn disconnected, Needs approval, Paused, Finished, Replied, Said no, Unsubscribed, Stopped, Left the audience, Removed, Step deleted, Rejected, Stopped in Trash, Already connected, Bounced, In cooldown, Mailbox removed, Couldn't read reply, Failed, Do not contact, In another sequence or Unreachable. Why it stands so is failure_reason, never this word. Set on the roster's list read; null on a read that did not judge it.
unreachable_reason
enum<string> | null
Which address the contact lacks, set only while being unreachable is what holds them: the Contacts tab reads it as Unreachable, and the audience eligibility counts them under missing_contact_details. Null for a reachable contact and for one who is settled or held by something named first (do not contact, another sequence, a cooldown).
Available options:
no_email,
no_linkedin_url,
no_email_or_linkedin_url
waiting_on
enum<string> | null
What the approval queue holds this contact behind, read from the task for their current step: a person's approval, a LinkedIn browser, or an approved email the engine has not sent yet. Null when nothing does.
Available options:
approval,
linkedin,
send
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Oneprofile","description":"How to use Oneprofile: find leads, enrich them, and run outreach.","colors":{"primary":"#0F5F5C","light":"#23CCC9","dark":"#15807E"},"appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Open Oneprofile","href":"https://app.getoneprofile.ai"}},"footer":{"socials":{"x":"https://x.com/getoneprofile","linkedin":"https://www.linkedin.com/company/getoneprofile"},"links":[{"header":"Product","items":[{"label":"Open Oneprofile","href":"https://app.getoneprofile.ai"},{"label":"Pricing","href":"https://www.getoneprofile.ai/pricing"},{"label":"Integrations","href":"https://www.getoneprofile.ai/integrations"}]},{"header":"Resources","items":[{"label":"Changelog","href":"https://docs.getoneprofile.ai/changelog"},{"label":"Blog","href":"https://www.getoneprofile.ai/blog"},{"label":"Contact support","href":"mailto:support@getoneprofile.ai"}]},{"header":"Legal","items":[{"label":"Terms of service","href":"https://www.getoneprofile.ai/terms"},{"label":"Privacy policy","href":"https://www.getoneprofile.ai/privacy-policy"}]}]},"icons":{"library":"lucide"},"integrations":{"posthog":{"apiKey":"phc_p9VapX8hW4khZqlz1QX0fNdDP8jtRhJiTofklwMgjaS","apiHost":"https://k.getoneprofile.ai"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"variables":{"appUrl":"https://app.getoneprofile.ai"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"oneprofile","hasAudioNarration":false,"actualSubdomain":"oneprofile","customDomains":["docs.getoneprofile.ai"],"gitSource":{"type":"github","owner":"getoneprofile","repo":"oneprofile","deployBranch":"master","contentDirectory":"product-docs/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afba5d7e2922ccc16a121c4","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API reference","count":718},{"language":"default","tag":"Endpoints","count":716},{"language":"default","tag":"sequences","count":111},{"language":"default","tag":"Documentation","count":105},{"language":"default","tag":"accounts","count":40},{"language":"default","tag":"senders","count":40},{"language":"default","tag":"table-enrichments","count":34},{"language":"default","tag":"find-leads","count":30},{"language":"default","tag":"inbox","count":27},{"language":"default","tag":"Outreach","count":26}],"searchSettings":{"maxResults":6}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sequences/move-one-contact-to-another-sequence","slug":"/api-reference/sequences/move-one-contact-to-another-sequence","pageMetadata":{"title":"Move one contact to another sequence","description":"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact's place in THIS sequence, now stopped.","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/{enrolment_id}/move/","href":"/api-reference/sequences/move-one-contact-to-another-sequence","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact’s place in THIS sequence, now stopped.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Move one contact to another sequence","description":"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact's place in THIS sequence, now stopped.","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/{enrolment_id}/move/","href":"/api-reference/sequences/move-one-contact-to-another-sequence","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact's place in THIS sequence, now stopped.","operationId":"move_enrolment","parameters":["b3f9dec2-e6d2-45d1-b280-1eb31e540d4d","868fc4ff-d57b-4d9f-bd85-e19eb362bf9b","74dbc515-0f3d-4580-a904-c9e8487f4f74"],"requestBody":"9b89425b-5c6b-4f49-bfdd-313f2e5d9ddd","responses":{"200":"cbc0e06e-ff3f-4f4b-becd-49c11498270c","401":"72fbcfe8-afec-4873-8e38-a0bdd52bbc88","403":"d5219f28-ef85-42fc-9ec8-c59fac8f8771","404":"f9ffcde8-8a74-42d7-93f8-afeb1f934af2","422":"36aa5a15-d3b9-4023-bd66-0532b0eb840b","500":"18d85ac9-dfc8-41b2-9449-79ba3df7e970","502":"743765dd-8aaa-44ea-ad8c-352152b1275d","503":"f2da190b-9506-439a-9ee9-8c7e028fec8b"},"security":["be9843fd-6ee4-4e85-8033-76f14d201026","1729e768-62f1-4663-92be-6ced040fbe1b"],"summary":"Move one contact to another sequence","tags":["sequences"],"method":"post","type":"path","servers":["dd0cf7df-0891-4373-a8b7-7572e7ccac12"],"path":"/sequences/{sequence_id}/contacts/{enrolment_id}/move/","baseUrlOptions":["https://api.getoneprofile.ai"],"title":"Move one contact to another sequence","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b3f9dec2-e6d2-45d1-b280-1eb31e540d4d":{"in":"path","name":"sequence_id","required":true,"schema":{"format":"uuid","title":"Sequence Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"868fc4ff-d57b-4d9f-bd85-e19eb362bf9b":{"in":"path","name":"enrolment_id","required":true,"schema":{"format":"uuid","title":"Enrolment Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"74dbc515-0f3d-4580-a904-c9e8487f4f74":{"description":"Answer what the action would do, exactly as the real call answers it, and change nothing.","in":"query","name":"dry_run","required":false,"schema":{"default":false,"description":"Answer what the action would do, exactly as the real call answers it, and change nothing.","title":"Dry Run","type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Where Move to another sequence should put the contact.","properties":{"target_sequence_id":{"description":"The sequence to move the contact to. It must send to the same table.","format":"uuid","title":"Target Sequence Id","type":"string","isRequired":true,"uniqueKey":"target_sequence_id","typeLabel":"string\u003cuuid>"}},"required":["target_sequence_id"],"title":"MoveContactRequestSchema","type":"object","uniqueKey":"","typeLabel":"MoveContactRequestSchema · object"},"examples":{"Example":{"title":"Example","value":{"target_sequence_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"cbc0e06e-ff3f-4f4b-becd-49c11498270c":{"content":{"application/json":{"schema":{"properties":{"bounced":{"title":"Bounced","type":"boolean","isRequired":true,"uniqueKey":"bounced","typeLabel":"boolean"},"company_key":{"oneOf":[{"type":"string","title":"Company Key","isRequired":true,"uniqueKey":"company_key.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Key","isRequired":true,"uniqueKey":"company_key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"company_key","typeLabel":"string | null"},"created_at":{"format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"current_step_id":{"oneOf":[{"type":"string","title":"Current Step Id","format":"uuid","isRequired":true,"uniqueKey":"current_step_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Current Step Id","isRequired":true,"uniqueKey":"current_step_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"current_step_id","typeLabel":"string\u003cuuid> | null"},"due_at":{"oneOf":[{"type":"string","title":"Due At","format":"date-time","isRequired":true,"uniqueKey":"due_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Due At","isRequired":true,"uniqueKey":"due_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"due_at","typeLabel":"string\u003cdate-time> | null"},"email":{"oneOf":[{"type":"string","title":"Email","isRequired":true,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","isRequired":true,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email","typeLabel":"string | null"},"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"record_id":{"format":"uuid","title":"Record Id","type":"string","isRequired":true,"uniqueKey":"record_id","typeLabel":"string\u003cuuid>"},"replied_at":{"oneOf":[{"type":"string","title":"Replied At","format":"date-time","isRequired":true,"uniqueKey":"replied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Replied At","isRequired":true,"uniqueKey":"replied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"replied_at","typeLabel":"string\u003cdate-time> | null"},"status":{"description":"Where one contact stands in one sequence.\n\nACTIVE rows carry a ``due_at`` and are what the tick claims; CLAIMED is the\nin-flight guard between claim and outcome. PAUSED is a deliberate\nper-contact hold: unclaimable because the tick claims strictly on ACTIVE,\nyet still LIVE. It keeps its step and its one-live-sequence slot, and a\ncompliance stop (reply, unsubscribe) reaches it. Everything else is\nsettled: COMPLETED walked off the end; STOPPED was halted (reply,\nunsubscribe, bounce, manual, company pause); FAILED is terminal;\nSUPPRESSED was on the do-not-contact list;\nSKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the\nreason visible in the grid.\n\nA contact the workspace's recontact rule refuses is STOPPED with\n``StopReason.COOLDOWN``. There is deliberately no held state: a cooldown\nsettles a contact rather than parking them, so nothing here waits on a date\nand nothing lets itself out later.\n\nAWAITING_ACTION is a contact parked behind a task that needs a\nperson or a channel, modelled on PAUSED: live, keeps its step and its\none-live-sequence slot, unclaimable because the tick claims strictly on\nACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by\nhand: only the outreach-task sweep does, once the task it waits on is\ndecided or delivered. Deliberately not \"awaiting approval\": an AUTO-mode\nLinkedIn park is waiting for a browser rather than for anyone's approval,\nand this value is the word the Contacts tab shows for both.\n\nPENDING is a draft's roster: in, standing on a step, and NOT live. Binding\nan audience enrols on the spot so the Contacts tab can show who is in, but\na sequence nobody has launched must not hold anybody's one-live-sequence\nslot, or a second sequence written for the same people skips them all.\n``uq_sequence_enrolment_one_live`` leaves PENDING out, the tick never\nclaims it, and launch turns each row ACTIVE, settling the ones another\nsequence took meanwhile as SKIPPED_DUPLICATE.","enum":["pending","active","claimed","paused","awaiting_action","completed","stopped","failed","suppressed","skipped_duplicate"],"title":"EnrolmentStatus","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"stop_reason":{"oneOf":[{"type":"string","title":"StopReason","enum":["reply","unsubscribe","do_not_contact","bounce","manual","company_reply","row_left_audience","row_left_paused","step_removed","removed","cooldown","rejected","mailbox_removed","unread_reply","declined","trashed","trashed_paused"],"isRequired":true,"uniqueKey":"stop_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"stop_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"stop_reason","typeLabel":"enum\u003cstring> | null"},"updated_at":{"format":"date-time","title":"Updated At","type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"browser_outcome":{"oneOf":[{"type":"object","title":"ContactBrowserOutcomeReadSchema","description":"The outcome the contact's latest settled Browser use run of this journey took, as the run settled on it: the Audience tab's Outcome column. Null until a run of theirs settles on one.","required":["step_id","key","label"],"properties":{"key":{"description":"The branch it settled on: outcome_1 to outcome_8, or needs_human.","enum":["default","yes","no","connected","already_connected","not_accepted","outcome_1","outcome_2","outcome_3","outcome_4","outcome_5","outcome_6","outcome_7","outcome_8","needs_human"],"title":"SequenceEdgeBranch","type":"string","isRequired":true,"uniqueKey":"browser_outcome.oneOf.0.key","typeLabel":"enum\u003cstring>"},"label":{"description":"The outcome's label as the run settled on it, kept through a later rename or removal of the outcome; 'Needs human' for needs_human.","title":"Label","type":"string","isRequired":true,"uniqueKey":"browser_outcome.oneOf.0.label","typeLabel":"string"},"step_id":{"description":"The Browser use step the run was of.","format":"uuid","title":"Step Id","type":"string","isRequired":true,"uniqueKey":"browser_outcome.oneOf.0.step_id","typeLabel":"string\u003cuuid>"},"broke_off":{"default":false,"description":"True when the run broke off on its own (a time limit, credits, the page) rather than the agent choosing Needs human; only ever with needs_human.","title":"Broke Off","type":"boolean","uniqueKey":"browser_outcome.oneOf.0.broke_off","typeLabel":"boolean"},"finished_at":{"oneOf":[{"type":"string","title":"Finished At","description":"When the run settled.","format":"date-time","uniqueKey":"browser_outcome.oneOf.0.finished_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Finished At","description":"When the run settled.","uniqueKey":"browser_outcome.oneOf.0.finished_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"browser_outcome.oneOf.0.finished_at","typeLabel":"string\u003cdate-time> | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","description":"Why the run ended there, in a sentence; null when unsaid.","uniqueKey":"browser_outcome.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","description":"Why the run ended there, in a sentence; null when unsaid.","uniqueKey":"browser_outcome.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"browser_outcome.oneOf.0.reason","typeLabel":"string | null"}},"uniqueKey":"browser_outcome.oneOf.0","typeLabel":"ContactBrowserOutcomeReadSchema · object"},{"type":"null","description":"The outcome the contact's latest settled Browser use run of this journey took, as the run settled on it: the Audience tab's Outcome column. Null until a run of theirs settles on one.","uniqueKey":"browser_outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"browser_outcome","typeLabel":"ContactBrowserOutcomeReadSchema · object | null"},"contact_company":{"oneOf":[{"type":"string","title":"Contact Company","description":"Their company, from whichever column of the audience row holds one.","uniqueKey":"contact_company.oneOf.0","typeLabel":"string"},{"type":"null","title":"Contact Company","description":"Their company, from whichever column of the audience row holds one.","uniqueKey":"contact_company.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact_company","typeLabel":"string | null"},"contact_name":{"oneOf":[{"type":"string","title":"Contact Name","description":"The person's name from their audience row: a full-name column where filled, else the given and family names joined. Null when the table names nobody.","uniqueKey":"contact_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Contact Name","description":"The person's name from their audience row: a full-name column where filled, else the given and family names joined. Null when the table names nobody.","uniqueKey":"contact_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact_name","typeLabel":"string | null"},"contact_number":{"default":0,"description":"This contact's ordinal within the sequence, from 1. A label of last resort, for a contact with neither an address nor a LinkedIn profile.","title":"Contact Number","type":"integer","uniqueKey":"contact_number","typeLabel":"integer"},"contact_title":{"oneOf":[{"type":"string","title":"Contact Title","description":"Their job title, from whichever column of the audience row holds one.","uniqueKey":"contact_title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Contact Title","description":"Their job title, from whichever column of the audience row holds one.","uniqueKey":"contact_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact_title","typeLabel":"string | null"},"cooldown_by_sequence":{"oneOf":[{"type":"object","title":"HeldBySequenceReadSchema","description":"On a contact the cooldown stopped (stop_reason cooldown): the other sequence of this workspace whose touch at last_contacted_at the stop is measured from. Null when that touch is older than the clock knowing its sequence, or the sequence is gone or in Trash.","required":["id","name"],"properties":{"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"cooldown_by_sequence.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"cooldown_by_sequence.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"cooldown_by_sequence.oneOf.0","typeLabel":"HeldBySequenceReadSchema · object"},{"type":"null","description":"On a contact the cooldown stopped (stop_reason cooldown): the other sequence of this workspace whose touch at last_contacted_at the stop is measured from. Null when that touch is older than the clock knowing its sequence, or the sequence is gone or in Trash.","uniqueKey":"cooldown_by_sequence.oneOf.1","typeLabel":"null"}],"uniqueKey":"cooldown_by_sequence","typeLabel":"HeldBySequenceReadSchema · object | null"},"cooldown_starts_at":{"oneOf":[{"type":"string","title":"Cooldown Starts At","description":"When a contact who starts on their own does, on a running sequence: the day the cooldown ends, or now once it has. Null on a paused sequence, where they start when it resumes, and for anyone who waits for a person.","format":"date-time","uniqueKey":"cooldown_starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Cooldown Starts At","description":"When a contact who starts on their own does, on a running sequence: the day the cooldown ends, or now once it has. Null on a paused sequence, where they start when it resumes, and for anyone who waits for a person.","uniqueKey":"cooldown_starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"cooldown_starts_at","typeLabel":"string\u003cdate-time> | null"},"cooldown_starts_by_itself":{"default":false,"description":"On a contact the cooldown stopped: true when they start on their own once it ends (this sequence is running or paused, nothing it sent reached them, and nothing else keeps them stopped). False means they stay stopped until a person resumes them.","title":"Cooldown Starts By Itself","type":"boolean","uniqueKey":"cooldown_starts_by_itself","typeLabel":"boolean"},"decides_at":{"oneOf":[{"type":"string","title":"Decides At","description":"For a contact on a condition that waits (Email bounced?, or an older Replied? or Accepted? check), or waiting for a connection request's answer: when the branch is decided. On a request it is when its answer window closes; in the past, the window is over and one more reading decides.","format":"date-time","uniqueKey":"decides_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Decides At","description":"For a contact on a condition that waits (Email bounced?, or an older Replied? or Accepted? check), or waiting for a connection request's answer: when the branch is decided. On a request it is when its answer window closes; in the past, the window is over and one more reading decides.","uniqueKey":"decides_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"decides_at","typeLabel":"string\u003cdate-time> | null"},"failure_code":{"oneOf":[{"type":"string","title":"EnrolmentFailureCode","description":"Which kind of failure stopped a failed contact, where it changes what Retry does: connected_before_withdraw (a Withdraw found them already connected; nothing to retry, so no Retry is offered) or invite_look_unreadable (the look at their profile could not tell whether they accepted; Retry looks again), or missing_values (a Browser use step's goal reads a value their row has none for, so it never ran and charged nothing; Retry runs it once the value is filled in, and leaves them failed while it is empty: see missing_values). Null for every other failure and status.","enum":["connected_before_withdraw","invite_look_unreadable","missing_values"],"uniqueKey":"failure_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Which kind of failure stopped a failed contact, where it changes what Retry does: connected_before_withdraw (a Withdraw found them already connected; nothing to retry, so no Retry is offered) or invite_look_unreadable (the look at their profile could not tell whether they accepted; Retry looks again), or missing_values (a Browser use step's goal reads a value their row has none for, so it never ran and charged nothing; Retry runs it once the value is filled in, and leaves them failed while it is empty: see missing_values). Null for every other failure and status.","uniqueKey":"failure_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure_code","typeLabel":"enum\u003cstring> | null"},"failure_reason":{"oneOf":[{"type":"string","title":"Failure Reason","description":"Why a failed contact stopped, in a sentence: for a LinkedIn step, the browser's own reason. The status cell says only Failed; this is the why. Retry runs the same step again. Null on every other status.","uniqueKey":"failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Failure Reason","description":"Why a failed contact stopped, in a sentence: for a LinkedIn step, the browser's own reason. The status cell says only Failed; this is the why. Retry runs the same step again. Null on every other status.","uniqueKey":"failure_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure_reason","typeLabel":"string | null"},"held_by_sequence":{"oneOf":[{"type":"object","title":"HeldBySequenceReadSchema","description":"On a contact skipped because they are in another live sequence (status skipped_duplicate): that sequence of this workspace, by id and name. Null for every other status, and once nothing holds the contact, which is when the next sync takes them in.","required":["id","name"],"properties":{"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"held_by_sequence.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"held_by_sequence.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"held_by_sequence.oneOf.0","typeLabel":"HeldBySequenceReadSchema · object"},{"type":"null","description":"On a contact skipped because they are in another live sequence (status skipped_duplicate): that sequence of this workspace, by id and name. Null for every other status, and once nothing holds the contact, which is when the next sync takes them in.","uniqueKey":"held_by_sequence.oneOf.1","typeLabel":"null"}],"uniqueKey":"held_by_sequence","typeLabel":"HeldBySequenceReadSchema · object | null"},"hold_reason":{"oneOf":[{"type":"string","title":"HoldReason","description":"Why the send path pushed this contact's next attempt out to due_at. Set only on an active contact whose due_at is still ahead. 'window' also covers a contact due on one of the sending window's openings, whoever scheduled them.","enum":["window","approved_window","daily_cap","no_mailbox","pacing","agent_unavailable","no_message","agent_writing","agent_queued","approval_queued","mailbox_waiting","no_linkedin_account","confirming_send","email_check","out_of_office","browser_queued","browser_running","browser_unavailable"],"uniqueKey":"hold_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why the send path pushed this contact's next attempt out to due_at. Set only on an active contact whose due_at is still ahead. 'window' also covers a contact due on one of the sending window's openings, whoever scheduled them.","uniqueKey":"hold_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"hold_reason","typeLabel":"enum\u003cstring> | null"},"invited_at":{"oneOf":[{"type":"string","title":"Invited At","description":"When the connection request this contact stands on went out, or was first seen already pending: set while they wait for its answer (and kept through a pause or a stop). Null on every other step, and on a completed contact.","format":"date-time","uniqueKey":"invited_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Invited At","description":"When the connection request this contact stands on went out, or was first seen already pending: set while they wait for its answer (and kept through a pause or a stop). Null on every other step, and on a completed contact.","uniqueKey":"invited_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invited_at","typeLabel":"string\u003cdate-time> | null"},"last_contacted_at":{"oneOf":[{"type":"string","title":"Last Contacted At","description":"The touch a cooldown stop is measured from. The sequence that made it is cooldown_by_sequence.","format":"date-time","uniqueKey":"last_contacted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Contacted At","description":"The touch a cooldown stop is measured from. The sequence that made it is cooldown_by_sequence.","uniqueKey":"last_contacted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_contacted_at","typeLabel":"string\u003cdate-time> | null"},"last_step_at":{"oneOf":[{"type":"string","title":"Last Step At","description":"When that step ran.","format":"date-time","uniqueKey":"last_step_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Step At","description":"When that step ran.","uniqueKey":"last_step_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_step_at","typeLabel":"string\u003cdate-time> | null"},"last_step_id":{"oneOf":[{"type":"string","title":"Last Step Id","description":"The step this contact last actually ran. Not the step before current_step_id: on a branching graph those are different steps.","format":"uuid","uniqueKey":"last_step_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Last Step Id","description":"The step this contact last actually ran. Not the step before current_step_id: on a branching graph those are different steps.","uniqueKey":"last_step_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_step_id","typeLabel":"string\u003cuuid> | null"},"linkedin_queue":{"oneOf":[{"type":"string","title":"LinkedInQueueState","description":"Set beside waiting_on 'linkedin': where the contact's step stands in the sending account's line. 'running' is in a browser now; 'queued' is in line (see linkedin_steps_ahead and linkedin_starts_at); the rest say why the line is not moving for it: the sequence's sending hours shut in the sender's timezone ('outside_window'), a daily or weekly limit for its kind, no browser checked in for fifteen minutes, LinkedIn asking to verify the account, or the account disconnected.","enum":["running","queued","checking_replies","outside_window","daily_limit","weekly_limit","kind_disabled","browser_offline","verify_account","disconnected"],"uniqueKey":"linkedin_queue.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Set beside waiting_on 'linkedin': where the contact's step stands in the sending account's line. 'running' is in a browser now; 'queued' is in line (see linkedin_steps_ahead and linkedin_starts_at); the rest say why the line is not moving for it: the sequence's sending hours shut in the sender's timezone ('outside_window'), a daily or weekly limit for its kind, no browser checked in for fifteen minutes, LinkedIn asking to verify the account, or the account disconnected.","uniqueKey":"linkedin_queue.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_queue","typeLabel":"enum\u003cstring> | null"},"linkedin_resets_at":{"oneOf":[{"type":"string","title":"Linkedin Resets At","description":"For a step held by a daily or weekly limit, when the limit it waits on resets (midnight in the sender's timezone). Null otherwise.","format":"date-time","uniqueKey":"linkedin_resets_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Linkedin Resets At","description":"For a step held by a daily or weekly limit, when the limit it waits on resets (midnight in the sender's timezone). Null otherwise.","uniqueKey":"linkedin_resets_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_resets_at","typeLabel":"string\u003cdate-time> | null"},"linkedin_starts_at":{"oneOf":[{"type":"string","title":"Linkedin Starts At","description":"When the step is expected to start, simulated the way the account's governor hands steps out: the next gap is exact, later gaps are the account's time between steps widened by the average jitter, and a step held by a daily or weekly limit starts after that limit resets. Null where no time can be named.","format":"date-time","uniqueKey":"linkedin_starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Linkedin Starts At","description":"When the step is expected to start, simulated the way the account's governor hands steps out: the next gap is exact, later gaps are the account's time between steps widened by the average jitter, and a step held by a daily or weekly limit starts after that limit resets. Null where no time can be named.","uniqueKey":"linkedin_starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_starts_at","typeLabel":"string\u003cdate-time> | null"},"linkedin_steps_ahead":{"oneOf":[{"type":"integer","title":"Linkedin Steps Ahead","description":"For a queued step, how many of the account's steps run before it.","uniqueKey":"linkedin_steps_ahead.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Linkedin Steps Ahead","description":"For a queued step, how many of the account's steps run before it.","uniqueKey":"linkedin_steps_ahead.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_steps_ahead","typeLabel":"integer | null"},"linkedin_url":{"oneOf":[{"type":"string","title":"Linkedin Url","uniqueKey":"linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Linkedin Url","uniqueKey":"linkedin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_url","typeLabel":"string | null"},"mailbox_address":{"oneOf":[{"type":"string","title":"Mailbox Address","description":"The address this sequence emails the contact from. Within one sequence a contact is only ever emailed from the mailbox that first emailed them there; another sequence starts fresh. Null until this sequence has emailed them.","uniqueKey":"mailbox_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mailbox Address","description":"The address this sequence emails the contact from. Within one sequence a contact is only ever emailed from the mailbox that first emailed them there; another sequence starts fresh. Null until this sequence has emailed them.","uniqueKey":"mailbox_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailbox_address","typeLabel":"string | null"},"mailbox_issue":{"oneOf":[{"type":"string","title":"MailboxIssue","description":"Why that mailbox cannot send for this sequence, set while it is what stops the contact (stop_reason mailbox_removed: deleted, not_on_sequence) or holds them (hold_reason mailbox_waiting: disconnected, no_sender).","enum":["deleted","not_on_sequence","disconnected","no_sender"],"uniqueKey":"mailbox_issue.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why that mailbox cannot send for this sequence, set while it is what stops the contact (stop_reason mailbox_removed: deleted, not_on_sequence) or holds them (hold_reason mailbox_waiting: disconnected, no_sender).","uniqueKey":"mailbox_issue.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailbox_issue","typeLabel":"enum\u003cstring> | null"},"missing_values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"missing_values.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Missing Values","description":"For a contact failed with failure_code missing_values: the values their Browser use step's goal reads that are still empty on their row now, in the goal's order. Empty once all are filled in, when Retry runs the step. Null for every other contact.","uniqueKey":"missing_values.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Missing Values","description":"For a contact failed with failure_code missing_values: the values their Browser use step's goal reads that are still empty on their row now, in the goal's order. Empty once all are filled in, when Retry runs the step. Null for every other contact.","uniqueKey":"missing_values.oneOf.1","typeLabel":"null"}],"uniqueKey":"missing_values","typeLabel":"string[] | null"},"reachable":{"default":true,"description":"Whether any channel this sequence's steps use can reach the contact: an email address for an email step, a LinkedIn profile URL for a LinkedIn one. A sequence with no sending step yet counts both.","title":"Reachable","type":"boolean","uniqueKey":"reachable","typeLabel":"boolean"},"row_deleted":{"default":false,"description":"The contact's row is no longer on the audience table: it was deleted. A contact who Left the audience with this false left the view the sequence follows instead.","title":"Row Deleted","type":"boolean","uniqueKey":"row_deleted","typeLabel":"boolean"},"status_word":{"oneOf":[{"type":"string","title":"Status Word","description":"The contact's status in the one word every surface says it in, as the Audience tab's chip reads: Not started, In progress, Scheduled, Daily limit, Weekly limit, Waiting for reply, Waiting for acceptance, Queued to write, Queued for approval, Writing, Writing delayed, Verifying email, Waiting for browser, Browsing, Browser unavailable, Approved, Limit at zero, No mailbox, No message, Browser offline, Verify account, LinkedIn disconnected, Needs approval, Paused, Finished, Replied, Said no, Unsubscribed, Stopped, Left the audience, Removed, Step deleted, Rejected, Stopped in Trash, Already connected, Bounced, In cooldown, Mailbox removed, Couldn't read reply, Failed, Do not contact, In another sequence or Unreachable. Why it stands so is failure_reason, never this word. Set on the roster's list read; null on a read that did not judge it.","uniqueKey":"status_word.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status Word","description":"The contact's status in the one word every surface says it in, as the Audience tab's chip reads: Not started, In progress, Scheduled, Daily limit, Weekly limit, Waiting for reply, Waiting for acceptance, Queued to write, Queued for approval, Writing, Writing delayed, Verifying email, Waiting for browser, Browsing, Browser unavailable, Approved, Limit at zero, No mailbox, No message, Browser offline, Verify account, LinkedIn disconnected, Needs approval, Paused, Finished, Replied, Said no, Unsubscribed, Stopped, Left the audience, Removed, Step deleted, Rejected, Stopped in Trash, Already connected, Bounced, In cooldown, Mailbox removed, Couldn't read reply, Failed, Do not contact, In another sequence or Unreachable. Why it stands so is failure_reason, never this word. Set on the roster's list read; null on a read that did not judge it.","uniqueKey":"status_word.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_word","typeLabel":"string | null"},"unreachable_reason":{"oneOf":[{"type":"string","title":"UnreachableReason","description":"Which address the contact lacks, set only while being unreachable is what holds them: the Contacts tab reads it as Unreachable, and the audience eligibility counts them under missing_contact_details. Null for a reachable contact and for one who is settled or held by something named first (do not contact, another sequence, a cooldown).","enum":["no_email","no_linkedin_url","no_email_or_linkedin_url"],"uniqueKey":"unreachable_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Which address the contact lacks, set only while being unreachable is what holds them: the Contacts tab reads it as Unreachable, and the audience eligibility counts them under missing_contact_details. Null for a reachable contact and for one who is settled or held by something named first (do not contact, another sequence, a cooldown).","uniqueKey":"unreachable_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"unreachable_reason","typeLabel":"enum\u003cstring> | null"},"waiting_on":{"oneOf":[{"type":"string","title":"WaitingOn","description":"What the approval queue holds this contact behind, read from the task for their current step: a person's approval, a LinkedIn browser, or an approved email the engine has not sent yet. Null when nothing does.","enum":["approval","linkedin","send"],"uniqueKey":"waiting_on.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"What the approval queue holds this contact behind, read from the task for their current step: a person's approval, a LinkedIn browser, or an approved email the engine has not sent yet. Null when nothing does.","uniqueKey":"waiting_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"waiting_on","typeLabel":"enum\u003cstring> | null"}},"required":["id","record_id","email","status","current_step_id","due_at","stop_reason","bounced","replied_at","company_key","created_at","updated_at"],"title":"EnrolmentReadSchema","type":"object","uniqueKey":"","typeLabel":"EnrolmentReadSchema · object"},"examples":{"Example":{"title":"Example","value":{"bounced":true,"company_key":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","current_step_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","due_at":"2023-11-07T05:31:56Z","email":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","record_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","replied_at":"2023-11-07T05:31:56Z","status":"pending","stop_reason":"reply","updated_at":"2023-11-07T05:31:56Z","browser_outcome":{"key":"default","label":"\u003cstring>","step_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","broke_off":false,"finished_at":"2023-11-07T05:31:56Z","reason":"\u003cstring>"},"contact_company":"\u003cstring>","contact_name":"\u003cstring>","contact_number":0,"contact_title":"\u003cstring>","cooldown_by_sequence":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"cooldown_starts_at":"2023-11-07T05:31:56Z","cooldown_starts_by_itself":false,"decides_at":"2023-11-07T05:31:56Z","failure_code":"connected_before_withdraw","failure_reason":"\u003cstring>","held_by_sequence":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"hold_reason":"window","invited_at":"2023-11-07T05:31:56Z","last_contacted_at":"2023-11-07T05:31:56Z","last_step_at":"2023-11-07T05:31:56Z","last_step_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","linkedin_queue":"running","linkedin_resets_at":"2023-11-07T05:31:56Z","linkedin_starts_at":"2023-11-07T05:31:56Z","linkedin_steps_ahead":123,"linkedin_url":"\u003cstring>","mailbox_address":"\u003cstring>","mailbox_issue":"deleted","missing_values":["\u003cstring>"],"reachable":true,"row_deleted":false,"status_word":"\u003cstring>","unreachable_reason":"no_email","waiting_on":"approval"}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"72fbcfe8-afec-4873-8e38-a0bdd52bbc88":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of why the request is unauthorized.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"UnauthorizedResponse","type":"object","uniqueKey":"","typeLabel":"UnauthorizedResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"d5219f28-ef85-42fc-9ec8-c59fac8f8771":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of why the request is forbidden.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"ForbiddenResponse","type":"object","uniqueKey":"","typeLabel":"ForbiddenResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"f9ffcde8-8a74-42d7-93f8-afeb1f934af2":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of why the resource was not found.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"NotFoundResponse","type":"object","uniqueKey":"","typeLabel":"NotFoundResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not found.","exampleType":"generated"},"36aa5a15-d3b9-4023-bd66-0532b0eb840b":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"issues":{"description":"The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message.","items":{"properties":{"input":{"oneOf":[{"type":"string","title":"Input","description":"The user's input that caused the error.","isRequired":true,"uniqueKey":"issues.items.[INDEX].input.oneOf.0","typeLabel":"string"},{"type":"integer","title":"Input","description":"The user's input that caused the error.","isRequired":true,"uniqueKey":"issues.items.[INDEX].input.oneOf.1","typeLabel":"integer"},{"type":"number","title":"Input","description":"The user's input that caused the error.","isRequired":true,"uniqueKey":"issues.items.[INDEX].input.oneOf.2","typeLabel":"number"},{"type":"boolean","title":"Input","description":"The user's input that caused the error.","isRequired":true,"uniqueKey":"issues.items.[INDEX].input.oneOf.3","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"issues.items.[INDEX].input.oneOf.4.items.[INDEX]","typeLabel":"any"},"title":"Input","description":"The user's input that caused the error.","isRequired":true,"uniqueKey":"issues.items.[INDEX].input.oneOf.4","typeLabel":"any[]"},{"type":"object","title":"Input","description":"The user's input that caused the error.","additionalProperties":true,"isRequired":true,"uniqueKey":"issues.items.[INDEX].input.oneOf.5","typeLabel":"Input · object"}],"isRequired":true,"uniqueKey":"issues.items.[INDEX].input","typeLabel":"string | integer | number | boolean | any[] | Input · object"},"loc":{"description":"The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present.","items":{"type":"string","uniqueKey":"issues.items.[INDEX].loc.items.[INDEX]","typeLabel":"string"},"title":"Loc","type":"array","isRequired":true,"uniqueKey":"issues.items.[INDEX].loc","typeLabel":"string[]"},"msg":{"description":"The message of the error. The error message to show to the user.","title":"Msg","type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].msg","typeLabel":"string"},"type":{"description":"The type of the error. Useful for frontend code to handle different types of errors.","title":"Type","type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].type","typeLabel":"string"}},"required":["loc","msg","type","input"],"title":"UnprocessableEntityIssue","type":"object","uniqueKey":"issues.items.[INDEX]","typeLabel":"UnprocessableEntityIssue · object"},"title":"Issues","type":"array","isRequired":true,"uniqueKey":"issues","typeLabel":"UnprocessableEntityIssue · object[]"}},"required":["detail","issues"],"title":"UnprocessableEntityResponse","type":"object","uniqueKey":"","typeLabel":"UnprocessableEntityResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","issues":[{"input":"\u003cstring>","loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"The target sequence would not take the contact; they stay here.","exampleType":"generated"},"18d85ac9-dfc8-41b2-9449-79ba3df7e970":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of why the server returned an error.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"ServerErrorResponse","type":"object","uniqueKey":"","typeLabel":"ServerErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Internal server error.","exampleType":"generated"},"743765dd-8aaa-44ea-ad8c-352152b1275d":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of why the server returned an error.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"ServerErrorResponse","type":"object","uniqueKey":"","typeLabel":"ServerErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Bad gateway error.","exampleType":"generated"},"f2da190b-9506-439a-9ee9-8c7e028fec8b":{"content":{"application/json":{"schema":{"properties":{"detail":{"description":"The detail of why the server returned an error.","title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"ServerErrorResponse","type":"object","uniqueKey":"","typeLabel":"ServerErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Service unavailable.","exampleType":"generated"}},"security":{"be9843fd-6ee4-4e85-8033-76f14d201026":{"APIKeyHeader":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"APIKeyHeader"}},"1729e768-62f1-4663-92be-6ced040fbe1b":{"HTTPBearer":{"scheme":"bearer","type":"http","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"dd0cf7df-0891-4373-a8b7-7572e7ccac12":{"url":"https://api.getoneprofile.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-Key"}],"title":"APIKeyHeader"},{"schemes":[{"scheme":{"scheme":"bearer","type":"http","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"oneprofile","siteName":"Oneprofile","title":"Move one contact to another sequence - Oneprofile","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T23:00:40.068Z","originalFileLocation":"api-reference/sequences/move-one-contact-to-another-sequence.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact\u0026#x27;s place in THIS sequence, now stopped.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Oneprofile\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/oneprofile/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/oneprofile/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/oneprofile/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/oneprofile/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Move one contact to another sequence - Oneprofile\">\u003cmeta data-mint-head property=\"og:description\" content=\"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact\u0026#x27;s place in THIS sequence, now stopped.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Oneprofile\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://oneprofile.mintlify.site/_mintlify/api/og/v2?division=sequences\u0026amp;title=Move+one+contact+to+another+sequence\u0026amp;description=Move+to+another+sequence%2C+all+or+nothing%3A+the+contact+leaves+this+sequence+only+when+the+target+takes+them.+When+the+target+cannot+%28no+address+it+can+use%2C+the+d\u0026amp;theme=32ff73a70f85208b60528902\u0026amp;signature=bbf60684fc05d0ebe15e49ec928b7368c2f15d522036be6145e25d43f65716a9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Move one contact to another sequence - Oneprofile\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact\u0026#x27;s place in THIS sequence, now stopped.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://oneprofile.mintlify.site/_mintlify/api/og/v2?division=sequences\u0026amp;title=Move+one+contact+to+another+sequence\u0026amp;description=Move+to+another+sequence%2C+all+or+nothing%3A+the+contact+leaves+this+sequence+only+when+the+target+takes+them.+When+the+target+cannot+%28no+address+it+can+use%2C+the+d\u0026amp;theme=32ff73a70f85208b60528902\u0026amp;signature=bbf60684fc05d0ebe15e49ec928b7368c2f15d522036be6145e25d43f65716a9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/oneprofile/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Oneprofile\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F5F5C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sequences/move-one-contact-to-another-sequence.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getoneprofile.ai/#organization\",\"name\":\"Oneprofile\",\"url\":\"https://docs.getoneprofile.ai\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getoneprofile.ai#website\",\"name\":\"Oneprofile\",\"url\":\"https://docs.getoneprofile.ai\",\"publisher\":{\"@id\":\"https://docs.getoneprofile.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence#webpage\",\"url\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence\",\"name\":\"Move one contact to another sequence\",\"description\":\"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact's place in THIS sequence, now stopped.\",\"dateModified\":\"2026-11-16T23:00:40.068Z\",\"isPartOf\":{\"@id\":\"https://docs.getoneprofile.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.getoneprofile.ai/api-reference/accounts/list-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"sequences\",\"item\":\"https://docs.getoneprofile.ai/api-reference/sequences/list-saved-email-templates\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Move one contact to another sequence\",\"item\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence#apireference\",\"headline\":\"Move one contact to another sequence\",\"name\":\"Move one contact to another sequence\",\"description\":\"Move to another sequence, all or nothing: the contact leaves this sequence only when the target takes them. When the target cannot (no address it can use, the do-not-contact list, the recontact rule, already in it, a different audience table) the answer is a 422 whose message says why, and the contact stays here untouched. Returns the contact's place in THIS sequence, now stopped.\",\"url\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getoneprofile.ai/api-reference/sequences/move-one-contact-to-another-sequence#webpage\"},\"dateModified\":\"2026-11-16T23:00:40.068Z\",\"publisher\":{\"@id\":\"https://docs.getoneprofile.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getoneprofile.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Oneprofile\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Oneprofile\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sequences/move-one-contact-to-another-sequence.md","siteName":"Oneprofile","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/get-started/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/find-people"}]},{"tab":"API reference","groups":[{"group":"API reference","pages":[{"title":"API reference","icon":"square-terminal","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/","href":"/api-reference/accounts/list-accounts"},{"title":"List account industries","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/industries/","href":"/api-reference/accounts/list-account-industries"},{"title":"Count accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/length/","href":"/api-reference/accounts/count-accounts"},{"title":"Get a company logo","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/logos/{logo_name}/","href":"/api-reference/accounts/get-a-company-logo"},{"title":"List account merges","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/merges/","href":"/api-reference/accounts/list-account-merges"},{"title":"Merge two accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/merges/","href":"/api-reference/accounts/merge-two-accounts"},{"title":"Preview an account merge","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/merges/preview/","href":"/api-reference/accounts/preview-an-account-merge"},{"title":"Undo an account merge","deprecated":null,"version":null,"openapi":"/openapi.json delete /accounts/merges/{from_key}/","href":"/api-reference/accounts/undo-an-account-merge"},{"title":"Find a person's account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/of-person/","href":"/api-reference/accounts/find-a-persons-account"},{"title":"List account owners","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/owners/","href":"/api-reference/accounts/list-account-owners"},{"title":"List account sources","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/sources/","href":"/api-reference/accounts/list-account-sources"},{"title":"Get a table's account source","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/sources/{table_id}/","href":"/api-reference/accounts/get-a-tables-account-source"},{"title":"Update a table's account source","deprecated":null,"version":null,"openapi":"/openapi.json patch /accounts/sources/{table_id}/","href":"/api-reference/accounts/update-a-tables-account-source"},{"title":"Get what a table puts on Accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/sources/{table_id}/reach/","href":"/api-reference/accounts/get-what-a-table-puts-on-accounts"},{"title":"Split a website out of an account","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/splits/","href":"/api-reference/accounts/split-a-website-out-of-an-account"},{"title":"Preview splitting a website out of an account","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/splits/preview/","href":"/api-reference/accounts/preview-splitting-a-website-out-of-an-account"},{"title":"Fold a split-out website back in","deprecated":null,"version":null,"openapi":"/openapi.json delete /accounts/splits/{host}/","href":"/api-reference/accounts/fold-a-split-out-website-back-in"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/","href":"/api-reference/accounts/get-an-account"},{"title":"Pin an account's fact","deprecated":null,"version":null,"openapi":"/openapi.json patch /accounts/{account_key}/facts/{kind}/","href":"/api-reference/accounts/pin-an-accounts-fact"},{"title":"Get an account's header","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/header/","href":"/api-reference/accounts/get-an-accounts-header"},{"title":"Read an account's map on LinkedIn","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/linkedin-maps/","href":"/api-reference/accounts/read-an-accounts-map-on-linkedin"},{"title":"Map an account on LinkedIn","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/{account_key}/linkedin-maps/","href":"/api-reference/accounts/map-an-account-on-linkedin"},{"title":"List accounts likely the same company","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/merge-suggestions/","href":"/api-reference/accounts/list-accounts-likely-the-same-company"},{"title":"Get an account's org chart","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/org-chart/","href":"/api-reference/accounts/get-an-accounts-org-chart"},{"title":"List an account's org chart changes","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/org-chart/changes/","href":"/api-reference/accounts/list-an-accounts-org-chart-changes"},{"title":"List an account's drafted reporting lines","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/org-chart/drafted-lines/","href":"/api-reference/accounts/list-an-accounts-drafted-reporting-lines"},{"title":"Confirm an account's drafted reporting lines","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/{account_key}/org-chart/drafted-lines/bulk/approve/","href":"/api-reference/accounts/confirm-an-accounts-drafted-reporting-lines"},{"title":"Reject an account's drafted reporting lines","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/{account_key}/org-chart/drafted-lines/bulk/reject/","href":"/api-reference/accounts/reject-an-accounts-drafted-reporting-lines"},{"title":"Restore an account's rejected drafted lines","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/{account_key}/org-chart/drafted-lines/bulk/restore/","href":"/api-reference/accounts/restore-an-accounts-rejected-drafted-lines"},{"title":"Draft an account's org chart","deprecated":null,"version":null,"openapi":"/openapi.json post /accounts/{account_key}/org-chart/drafts/","href":"/api-reference/accounts/draft-an-accounts-org-chart"},{"title":"Forget a person an account's org chart lost","deprecated":null,"version":null,"openapi":"/openapi.json delete /accounts/{account_key}/org-chart/lost/","href":"/api-reference/accounts/forget-a-person-an-accounts-org-chart-lost"},{"title":"Get an account's overview","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/overview/","href":"/api-reference/accounts/get-an-accounts-overview"},{"title":"Write the people search for finding more people at an account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/people-search/","href":"/api-reference/accounts/write-the-people-search-for-finding-more-people-at-an-account"},{"title":"List an account's people","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/people/","href":"/api-reference/accounts/list-an-accounts-people"},{"title":"Count an account's people by each People filter","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/people/facets/","href":"/api-reference/accounts/count-an-accounts-people-by-each-people-filter"},{"title":"Count an account's people","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/people/length/","href":"/api-reference/accounts/count-an-accounts-people"},{"title":"Get one person at an account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/people/{person_id}/","href":"/api-reference/accounts/get-one-person-at-an-account"},{"title":"Update a person on an account's org chart","deprecated":null,"version":null,"openapi":"/openapi.json patch /accounts/{account_key}/people/{person_id}/","href":"/api-reference/accounts/update-a-person-on-an-accounts-org-chart"},{"title":"List who a person's manager pick would loop through","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/people/{person_id}/manager-loops/","href":"/api-reference/accounts/list-who-a-persons-manager-pick-would-loop-through"},{"title":"List the websites under an account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{account_key}/websites/","href":"/api-reference/accounts/list-the-websites-under-an-account"}]},{"group":"affiliate","pages":[{"title":"Enroll in the affiliate program","deprecated":null,"version":null,"openapi":"/openapi.json post /affiliate/enroll/","href":"/api-reference/affiliate/enroll-in-the-affiliate-program"},{"title":"List the affiliate activity feed","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/feed/","href":"/api-reference/affiliate/list-the-affiliate-activity-feed"},{"title":"List the affiliate ledger","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/ledger/","href":"/api-reference/affiliate/list-the-affiliate-ledger"},{"title":"List payouts","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/payouts/","href":"/api-reference/affiliate/list-payouts"},{"title":"Get the affiliate performance figures","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/performance/","href":"/api-reference/affiliate/get-the-affiliate-performance-figures"},{"title":"Get the affiliate program's current terms","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/program/","href":"/api-reference/affiliate/get-the-affiliate-programs-current-terms"},{"title":"List the affiliate referrals","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/referrals/","href":"/api-reference/affiliate/list-the-affiliate-referrals"},{"title":"Update the affiliate settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /affiliate/settings/","href":"/api-reference/affiliate/update-the-affiliate-settings"},{"title":"List the affiliate per-source performance","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/sources/","href":"/api-reference/affiliate/list-the-affiliate-per-source-performance"},{"title":"Get the affiliate headline stats","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/stats/","href":"/api-reference/affiliate/get-the-affiliate-headline-stats"},{"title":"Get the affiliate dashboard summary","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/summary/","href":"/api-reference/affiliate/get-the-affiliate-dashboard-summary"},{"title":"List the affiliate per-day stats","deprecated":null,"version":null,"openapi":"/openapi.json get /affiliate/timeseries/","href":"/api-reference/affiliate/list-the-affiliate-per-day-stats"},{"title":"Start identity verification","deprecated":null,"version":null,"openapi":"/openapi.json post /affiliate/verification-sessions/","href":"/api-reference/affiliate/start-identity-verification"}]},{"group":"agent-learnings","pages":[{"title":"List an agent's learnings","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/","href":"/api-reference/agent-learnings/list-an-agents-learnings"},{"title":"Add a learning","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/","href":"/api-reference/agent-learnings/add-a-learning"},{"title":"Move a shared rule to all sequences","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/bulk/promote/","href":"/api-reference/agent-learnings/move-a-shared-rule-to-all-sequences"},{"title":"Say where the feedback on some subjects stands","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/feedback-states/query/","href":"/api-reference/agent-learnings/say-where-the-feedback-on-some-subjects-stands"},{"title":"Propose a learning from an edit","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/hand-edits/","href":"/api-reference/agent-learnings/propose-a-learning-from-an-edit"},{"title":"Read the rules several sequences share","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/overlap/","href":"/api-reference/agent-learnings/read-the-rules-several-sequences-share"},{"title":"Price a thumbs down's redo","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/quote/","href":"/api-reference/agent-learnings/price-a-thumbs-downs-redo"},{"title":"Start a learning request in the background","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/requests/","href":"/api-reference/agent-learnings/start-a-learning-request-in-the-background"},{"title":"Get a learning request","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/requests/{request_id}/","href":"/api-reference/agent-learnings/get-a-learning-request"},{"title":"Mark a sent message Looks good","deprecated":null,"version":null,"openapi":"/openapi.json put /agent-learnings/sent-messages/{message_id}/looks-good/","href":"/api-reference/agent-learnings/mark-a-sent-message-looks-good"},{"title":"List the thumbs downs on some subjects","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/thumbs-downs/","href":"/api-reference/agent-learnings/list-the-thumbs-downs-on-some-subjects"},{"title":"Give a thumbs down","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/thumbs-downs/","href":"/api-reference/agent-learnings/give-a-thumbs-down"},{"title":"Get a thumbs down","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/thumbs-downs/{event_id}/","href":"/api-reference/agent-learnings/get-a-thumbs-down"},{"title":"Change one change of a feedback session","deprecated":null,"version":null,"openapi":"/openapi.json patch /agent-learnings/thumbs-downs/{event_id}/changes/{change_id}/","href":"/api-reference/agent-learnings/change-one-change-of-a-feedback-session"},{"title":"Save a proposed learning","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/thumbs-downs/{event_id}/commit/","href":"/api-reference/agent-learnings/save-a-proposed-learning"},{"title":"Change a proposed learning","deprecated":null,"version":null,"openapi":"/openapi.json patch /agent-learnings/thumbs-downs/{event_id}/proposal/","href":"/api-reference/agent-learnings/change-a-proposed-learning"},{"title":"Rewrite again for a proposed learning","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/thumbs-downs/{event_id}/regenerate/","href":"/api-reference/agent-learnings/rewrite-again-for-a-proposed-learning"},{"title":"Discard a thumbs down's feedback","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/thumbs-downs/{event_id}/revert/","href":"/api-reference/agent-learnings/discard-a-thumbs-downs-feedback"},{"title":"List learning versions","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-learnings/versions/","href":"/api-reference/agent-learnings/list-learning-versions"},{"title":"Restore a learning version","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/versions/{version_id}/restore/","href":"/api-reference/agent-learnings/restore-a-learning-version"},{"title":"Delete a learning","deprecated":null,"version":null,"openapi":"/openapi.json delete /agent-learnings/{learning_id}/","href":"/api-reference/agent-learnings/delete-a-learning"},{"title":"Rewrite a learning","deprecated":null,"version":null,"openapi":"/openapi.json patch /agent-learnings/{learning_id}/","href":"/api-reference/agent-learnings/rewrite-a-learning"},{"title":"Move a learning","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-learnings/{learning_id}/move/","href":"/api-reference/agent-learnings/move-a-learning"}]},{"group":"outbound-agents","pages":[{"title":"Read whether the agent's own sending is paused","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-sending/","href":"/api-reference/outbound-agents/read-whether-the-agents-own-sending-is-paused"},{"title":"Pause or resume the agent's own sending","deprecated":null,"version":null,"openapi":"/openapi.json patch /agent-sending/","href":"/api-reference/outbound-agents/pause-or-resume-the-agents-own-sending"},{"title":"List the campaign library","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/campaigns/","href":"/api-reference/outbound-agents/list-the-campaign-library"},{"title":"Read what a new outbound agent starts with","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/defaults/","href":"/api-reference/outbound-agents/read-what-a-new-outbound-agent-starts-with"},{"title":"Read today's preview allowance","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/preview-allowance/","href":"/api-reference/outbound-agents/read-todays-preview-allowance"},{"title":"List what each outbound agent model costs","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/prices/","href":"/api-reference/outbound-agents/list-what-each-outbound-agent-model-costs"},{"title":"Read an outbound agent","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/","href":"/api-reference/outbound-agents/read-an-outbound-agent"},{"title":"Change an outbound agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /outbound-agents/{agent_id}/","href":"/api-reference/outbound-agents/change-an-outbound-agent"},{"title":"List the agent's conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/conversations/","href":"/api-reference/outbound-agents/list-the-agents-conversations"},{"title":"Read one contact's conversation with the agent","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/conversations/{subject_key}/","href":"/api-reference/outbound-agents/read-one-contacts-conversation-with-the-agent"},{"title":"Drop one fact from a contact's research","deprecated":null,"version":null,"openapi":"/openapi.json delete /outbound-agents/{agent_id}/conversations/{subject_key}/facts/{index}/","href":"/api-reference/outbound-agents/drop-one-fact-from-a-contacts-research"},{"title":"List what people told the agent","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/feedback/","href":"/api-reference/outbound-agents/list-what-people-told-the-agent"},{"title":"Rate one message the agent wrote","deprecated":null,"version":null,"openapi":"/openapi.json post /outbound-agents/{agent_id}/feedback/","href":"/api-reference/outbound-agents/rate-one-message-the-agent-wrote"},{"title":"Undo your feedback","deprecated":null,"version":null,"openapi":"/openapi.json delete /outbound-agents/{agent_id}/feedback/{feedback_id}/","href":"/api-reference/outbound-agents/undo-your-feedback"},{"title":"Edit your feedback","deprecated":null,"version":null,"openapi":"/openapi.json patch /outbound-agents/{agent_id}/feedback/{feedback_id}/","href":"/api-reference/outbound-agents/edit-your-feedback"},{"title":"Read one message the agent wrote","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/messages/{message_id}/","href":"/api-reference/outbound-agents/read-one-message-the-agent-wrote"},{"title":"Rewrite one message the agent wrote","deprecated":null,"version":null,"openapi":"/openapi.json patch /outbound-agents/{agent_id}/messages/{message_id}/","href":"/api-reference/outbound-agents/rewrite-one-message-the-agent-wrote"},{"title":"Have the agent write one message again","deprecated":null,"version":null,"openapi":"/openapi.json post /outbound-agents/{agent_id}/messages/{message_id}/regenerate/","href":"/api-reference/outbound-agents/have-the-agent-write-one-message-again"},{"title":"List an outbound agent's versions","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/versions/","href":"/api-reference/outbound-agents/list-an-outbound-agents-versions"},{"title":"Compare a writing version","deprecated":null,"version":null,"openapi":"/openapi.json get /outbound-agents/{agent_id}/versions/{version}/changes/","href":"/api-reference/outbound-agents/compare-a-writing-version"},{"title":"Revert an outbound agent to an earlier version","deprecated":null,"version":null,"openapi":"/openapi.json post /outbound-agents/{agent_id}/versions/{version}/revert/","href":"/api-reference/outbound-agents/revert-an-outbound-agent-to-an-earlier-version"}]},{"group":"agent-training","pages":[{"title":"Show the examples a table would give","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-training/sample-rows/preview/","href":"/api-reference/agent-training/show-the-examples-a-table-would-give"},{"title":"Suggest examples to preview","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-training/sample-rows/suggestions/","href":"/api-reference/agent-training/suggest-examples-to-preview"},{"title":"List Previews","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-training/sessions/","href":"/api-reference/agent-training/list-previews"},{"title":"Open a Preview","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-training/sessions/","href":"/api-reference/agent-training/open-a-preview"},{"title":"Discard a Preview","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-training/sessions/{session_id}/abandon/","href":"/api-reference/agent-training/discard-a-preview"},{"title":"Close a Preview","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-training/sessions/{session_id}/complete/","href":"/api-reference/agent-training/close-a-preview"},{"title":"Mark an example Looks good","deprecated":null,"version":null,"openapi":"/openapi.json put /agent-training/sessions/{session_id}/rows/{row_id}/feedback/","href":"/api-reference/agent-training/mark-an-example-looks-good"}]},{"group":"ai_apps","pages":[{"title":"List connected AI apps","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-apps/","href":"/api-reference/ai_apps/list-connected-ai-apps"},{"title":"Read an AI app's request to connect","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-apps/requests/{request_id}/","href":"/api-reference/ai_apps/read-an-ai-apps-request-to-connect"},{"title":"Connect an AI app","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-apps/requests/{request_id}/approve/","href":"/api-reference/ai_apps/connect-an-ai-app"},{"title":"Turn down an AI app","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-apps/requests/{request_id}/reject/","href":"/api-reference/ai_apps/turn-down-an-ai-app"},{"title":"Disconnect an AI app","deprecated":null,"version":null,"openapi":"/openapi.json delete /ai-apps/{ai_app_id}/","href":"/api-reference/ai_apps/disconnect-an-ai-app"}]},{"group":"ai-context","pages":[{"title":"Get the AI context","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-context/","href":"/api-reference/ai-context/get-the-ai-context"},{"title":"Update the AI context","deprecated":null,"version":null,"openapi":"/openapi.json patch /ai-context/","href":"/api-reference/ai-context/update-the-ai-context"},{"title":"List the reference documents","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-context/documents/","href":"/api-reference/ai-context/list-the-reference-documents"},{"title":"Upload a reference document","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-context/documents/","href":"/api-reference/ai-context/upload-a-reference-document"},{"title":"Link reference documents from Google Drive","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-context/documents/bulk/","href":"/api-reference/ai-context/link-reference-documents-from-google-drive"},{"title":"Get a reference document","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-context/documents/{document_id}/","href":"/api-reference/ai-context/get-a-reference-document"},{"title":"Delete a reference document","deprecated":null,"version":null,"openapi":"/openapi.json delete /ai-context/documents/{document_id}/","href":"/api-reference/ai-context/delete-a-reference-document"},{"title":"Update a reference document","deprecated":null,"version":null,"openapi":"/openapi.json patch /ai-context/documents/{document_id}/","href":"/api-reference/ai-context/update-a-reference-document"},{"title":"Download a reference document","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-context/documents/{document_id}/download/","href":"/api-reference/ai-context/download-a-reference-document"},{"title":"Rewrite a reference document's summary","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-context/documents/{document_id}/summary/regenerate/","href":"/api-reference/ai-context/rewrite-a-reference-documents-summary"},{"title":"Refresh a reference document from Google Drive","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-context/documents/{document_id}/sync/","href":"/api-reference/ai-context/refresh-a-reference-document-from-google-drive"},{"title":"List the Q\u0026A","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-context/qa/","href":"/api-reference/ai-context/list-the-q\u0026a"},{"title":"Add an answer to the Q\u0026A","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-context/qa/","href":"/api-reference/ai-context/add-an-answer-to-the-q\u0026a"},{"title":"Delete a Q\u0026A answer","deprecated":null,"version":null,"openapi":"/openapi.json delete /ai-context/qa/{entry_id}/","href":"/api-reference/ai-context/delete-a-q\u0026a-answer"},{"title":"Change a Q\u0026A answer","deprecated":null,"version":null,"openapi":"/openapi.json patch /ai-context/qa/{entry_id}/","href":"/api-reference/ai-context/change-a-q\u0026a-answer"},{"title":"Write the AI context from a company domain","deprecated":null,"version":null,"openapi":"/openapi.json post /ai-context/runs/","href":"/api-reference/ai-context/write-the-ai-context-from-a-company-domain"},{"title":"Get a generation run","deprecated":null,"version":null,"openapi":"/openapi.json get /ai-context/runs/{run_id}/","href":"/api-reference/ai-context/get-a-generation-run"}]},{"group":"apikey","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /api-keys/","href":"/api-reference/apikey/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /api-keys/","href":"/api-reference/apikey/create-an-api-key"},{"title":"Get the number of API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /api-keys/length/","href":"/api-reference/apikey/get-the-number-of-api-keys"},{"title":"List the API key scopes this workspace may create","deprecated":null,"version":null,"openapi":"/openapi.json get /api-keys/scopes/","href":"/api-reference/apikey/list-the-api-key-scopes-this-workspace-may-create"},{"title":"Get an API key","deprecated":null,"version":null,"openapi":"/openapi.json get /api-keys/{api_key_id}/","href":"/api-reference/apikey/get-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /api-keys/{api_key_id}/","href":"/api-reference/apikey/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/openapi.json patch /api-keys/{api_key_id}/","href":"/api-reference/apikey/update-an-api-key"}]},{"group":"app-listings","pages":[{"title":"Finalize a switch/reconnect onto an existing integration","deprecated":null,"version":null,"openapi":"/openapi.json post /app-listings/connections/{connection_id}/claim/","href":"/api-reference/app-listings/finalize-a-switchreconnect-onto-an-existing-integration"},{"title":"Get a pending connection's captured connect-time config","deprecated":null,"version":null,"openapi":"/openapi.json get /app-listings/connections/{connection_id}/config/","href":"/api-reference/app-listings/get-a-pending-connections-captured-connect-time-config"},{"title":"Start an app listing OAuth install","deprecated":null,"version":null,"openapi":"/openapi.json post /app-listings/{slug}/authorize/","href":"/api-reference/app-listings/start-an-app-listing-oauth-install"},{"title":"Exchange an app listing OAuth callback","deprecated":null,"version":null,"openapi":"/openapi.json post /app-listings/{slug}/callback/","href":"/api-reference/app-listings/exchange-an-app-listing-oauth-callback"},{"title":"Check a workspace resolves before connecting","deprecated":null,"version":null,"openapi":"/openapi.json post /app-listings/{slug}/check/","href":"/api-reference/app-listings/check-a-workspace-resolves-before-connecting"},{"title":"List an app listing's connect-time inputs","deprecated":null,"version":null,"openapi":"/openapi.json get /app-listings/{slug}/connect-inputs/","href":"/api-reference/app-listings/list-an-app-listings-connect-time-inputs"}]},{"group":"workspace-actions","pages":[{"title":"List the AI Assistant's proposed and applied actions","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/actions/","href":"/api-reference/workspace-actions/list-the-ai-assistants-proposed-and-applied-actions"},{"title":"Approve every action one reply proposed","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/actions/bulk/approve/","href":"/api-reference/workspace-actions/approve-every-action-one-reply-proposed"},{"title":"Read one proposed or applied action","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/actions/{proposal_id}/","href":"/api-reference/workspace-actions/read-one-proposed-or-applied-action"},{"title":"Approve a proposed action","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/actions/{proposal_id}/approve/","href":"/api-reference/workspace-actions/approve-a-proposed-action"},{"title":"Reject a proposed action","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/actions/{proposal_id}/reject/","href":"/api-reference/workspace-actions/reject-a-proposed-action"},{"title":"Read what a conversation may apply without asking","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/conversations/{conversation_id}/grants/","href":"/api-reference/workspace-actions/read-what-a-conversation-may-apply-without-asking"},{"title":"Change what a conversation may apply without asking","deprecated":null,"version":null,"openapi":"/openapi.json patch /assistant/conversations/{conversation_id}/grants/","href":"/api-reference/workspace-actions/change-what-a-conversation-may-apply-without-asking"},{"title":"List what the AI Assistant does without asking you","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/my-grants/","href":"/api-reference/workspace-actions/list-what-the-ai-assistant-does-without-asking-you"},{"title":"Take back something you allowed the AI Assistant to do without asking you","deprecated":null,"version":null,"openapi":"/openapi.json delete /assistant/my-grants/{tool}/","href":"/api-reference/workspace-actions/take-back-something-you-allowed-the-ai-assistant-to-do-without-asking-you"},{"title":"Read the AI Assistant's action settings","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/settings/","href":"/api-reference/workspace-actions/read-the-ai-assistants-action-settings"},{"title":"Change the AI Assistant's action settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /assistant/settings/","href":"/api-reference/workspace-actions/change-the-ai-assistants-action-settings"},{"title":"List the actions the AI Assistant can take","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/verbs/","href":"/api-reference/workspace-actions/list-the-actions-the-ai-assistant-can-take"}]},{"group":"assistant","pages":[{"title":"List AI Assistant chat conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/conversations/","href":"/api-reference/assistant/list-ai-assistant-chat-conversations"},{"title":"Start an AI Assistant chat conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/conversations/","href":"/api-reference/assistant/start-an-ai-assistant-chat-conversation"},{"title":"List AI Assistant chat messages","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/conversations/{conversation_id}/messages/","href":"/api-reference/assistant/list-ai-assistant-chat-messages"},{"title":"Ask the AI Assistant","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/conversations/{conversation_id}/messages/","href":"/api-reference/assistant/ask-the-ai-assistant"},{"title":"Ask the AI Assistant, streaming its work","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/conversations/{conversation_id}/messages/stream/","href":"/api-reference/assistant/ask-the-ai-assistant-streaming-its-work"},{"title":"Resume an AI Assistant turn waiting on your approval","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/conversations/{conversation_id}/messages/{sequence}/resume/stream/","href":"/api-reference/assistant/resume-an-ai-assistant-turn-waiting-on-your-approval"},{"title":"Stop an AI Assistant chat turn","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/conversations/{conversation_id}/messages/{sequence}/stop/","href":"/api-reference/assistant/stop-an-ai-assistant-chat-turn"},{"title":"List AI Assistant threads","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/threads/","href":"/api-reference/assistant/list-ai-assistant-threads"},{"title":"Delete an AI Assistant thread","deprecated":null,"version":null,"openapi":"/openapi.json delete /assistant/threads/{thread_id}/","href":"/api-reference/assistant/delete-an-ai-assistant-thread"},{"title":"Rename or pin an AI Assistant thread","deprecated":null,"version":null,"openapi":"/openapi.json patch /assistant/threads/{thread_id}/","href":"/api-reference/assistant/rename-or-pin-an-ai-assistant-thread"},{"title":"Link an AI Assistant thread to the one it continues in","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/threads/{thread_id}/link/","href":"/api-reference/assistant/link-an-ai-assistant-thread-to-the-one-it-continues-in"},{"title":"List what the AI Assistant can do","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/tools/","href":"/api-reference/assistant/list-what-the-ai-assistant-can-do"},{"title":"Add a file to send with an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json post /chat-attachments/","href":"/api-reference/assistant/add-a-file-to-send-with-an-ai-assistant-message"},{"title":"Read a file attached to an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/","href":"/api-reference/assistant/read-a-file-attached-to-an-ai-assistant-message"},{"title":"Remove a file added to an AI Assistant message before it was sent","deprecated":null,"version":null,"openapi":"/openapi.json delete /chat-attachments/{attachment_id}/","href":"/api-reference/assistant/remove-a-file-added-to-an-ai-assistant-message-before-it-was-sent"},{"title":"Read an attached file column's value distribution","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/columns/{source_index}/distribution/","href":"/api-reference/assistant/read-an-attached-file-columns-value-distribution"},{"title":"List an attached file column's raw values","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/columns/{source_index}/values/","href":"/api-reference/assistant/list-an-attached-file-columns-raw-values"},{"title":"List the comments on no data row of a file attached to an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/comments/","href":"/api-reference/assistant/list-the-comments-on-no-data-row-of-a-file-attached-to-an-ai-assistant-message"},{"title":"Build a table from a file attached to an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json post /chat-attachments/{attachment_id}/import/","href":"/api-reference/assistant/build-a-table-from-a-file-attached-to-an-ai-assistant-message"},{"title":"Read pages of a PDF attached to an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/pages/","href":"/api-reference/assistant/read-pages-of-a-pdf-attached-to-an-ai-assistant-message"},{"title":"Read rows of a file attached to an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/rows/","href":"/api-reference/assistant/read-rows-of-a-file-attached-to-an-ai-assistant-message"},{"title":"Count the rows of a file attached to an AI Assistant message","deprecated":null,"version":null,"openapi":"/openapi.json get /chat-attachments/{attachment_id}/rows/length/","href":"/api-reference/assistant/count-the-rows-of-a-file-attached-to-an-ai-assistant-message"}]},{"group":"assistant-prompt","pages":[{"title":"List the saved prompts","deprecated":null,"version":null,"openapi":"/openapi.json get /assistant/prompts/","href":"/api-reference/assistant-prompt/list-the-saved-prompts"},{"title":"Save a prompt","deprecated":null,"version":null,"openapi":"/openapi.json post /assistant/prompts/","href":"/api-reference/assistant-prompt/save-a-prompt"},{"title":"Delete a saved prompt","deprecated":null,"version":null,"openapi":"/openapi.json delete /assistant/prompts/{prompt_id}/","href":"/api-reference/assistant-prompt/delete-a-saved-prompt"},{"title":"Rewrite a saved prompt","deprecated":null,"version":null,"openapi":"/openapi.json patch /assistant/prompts/{prompt_id}/","href":"/api-reference/assistant-prompt/rewrite-a-saved-prompt"}]},{"group":"attribution","pages":[{"title":"Record where a new workspace came from","deprecated":null,"version":null,"openapi":"/openapi.json put /attribution/signup-source/","href":"/api-reference/attribution/record-where-a-new-workspace-came-from"},{"title":"Announce the caller's signup","deprecated":null,"version":null,"openapi":"/openapi.json put /attribution/signup/","href":"/api-reference/attribution/announce-the-callers-signup"}]},{"group":"billing","pages":[{"title":"Start a credit pack purchase","deprecated":null,"version":null,"openapi":"/openapi.json post /billing/checkout-sessions/","href":"/api-reference/billing/start-a-credit-pack-purchase"},{"title":"Get credit pack quote","deprecated":null,"version":null,"openapi":"/openapi.json get /billing/credit-packs/quote/","href":"/api-reference/billing/get-credit-pack-quote"},{"title":"List published credit prices","deprecated":null,"version":null,"openapi":"/openapi.json get /billing/credit-prices/","href":"/api-reference/billing/list-published-credit-prices"},{"title":"Create billing portal session","deprecated":null,"version":null,"openapi":"/openapi.json post /billing/portal-sessions/","href":"/api-reference/billing/create-billing-portal-session"},{"title":"List available products","deprecated":null,"version":null,"openapi":"/openapi.json get /billing/products/","href":"/api-reference/billing/list-available-products"},{"title":"Get subscription information","deprecated":null,"version":null,"openapi":"/openapi.json get /billing/subscription/","href":"/api-reference/billing/get-subscription-information"},{"title":"Switch subscription plan","deprecated":null,"version":null,"openapi":"/openapi.json post /billing/subscription/switch-plan/","href":"/api-reference/billing/switch-subscription-plan"},{"title":"List billing transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /billing/transactions/","href":"/api-reference/billing/list-billing-transactions"}]},{"group":"table-templates","pages":[{"title":"List column templates","deprecated":null,"version":null,"openapi":"/openapi.json get /column-templates/","href":"/api-reference/table-templates/list-column-templates"},{"title":"Capture a multi-column template","deprecated":null,"version":null,"openapi":"/openapi.json post /column-templates/","href":"/api-reference/table-templates/capture-a-multi-column-template"},{"title":"Delete a column template","deprecated":null,"version":null,"openapi":"/openapi.json delete /column-templates/{template_id}/","href":"/api-reference/table-templates/delete-a-column-template"},{"title":"Apply a template to a table","deprecated":null,"version":null,"openapi":"/openapi.json post /column-templates/{template_id}/apply/","href":"/api-reference/table-templates/apply-a-template-to-a-table"}]},{"group":"contact_cooldown","pages":[{"title":"Read the workspace's cooldown rules","deprecated":null,"version":null,"openapi":"/openapi.json get /cooldown/settings/","href":"/api-reference/contact_cooldown/read-the-workspaces-cooldown-rules"},{"title":"Update the workspace's cooldown rules","deprecated":null,"version":null,"openapi":"/openapi.json patch /cooldown/settings/","href":"/api-reference/contact_cooldown/update-the-workspaces-cooldown-rules"}]},{"group":"credits","pages":[{"title":"List credit ledger entries","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/ledger/","href":"/api-reference/credits/list-credit-ledger-entries"},{"title":"Get the credit balance summary","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/summary/","href":"/api-reference/credits/get-the-credit-balance-summary"},{"title":"Get the balance-over-time series","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/balance-timeseries/","href":"/api-reference/credits/get-the-balance-over-time-series"},{"title":"List credit spend attributed to saved agents","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-agent/","href":"/api-reference/credits/list-credit-spend-attributed-to-saved-agents"},{"title":"Count the saved agents that spent credits","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-agent/length/","href":"/api-reference/credits/count-the-saved-agents-that-spent-credits"},{"title":"Get credit spend attributed to providers and accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-provider/","href":"/api-reference/credits/get-credit-spend-attributed-to-providers-and-accounts"},{"title":"List credit spend attributed to tables and columns","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-table/","href":"/api-reference/credits/list-credit-spend-attributed-to-tables-and-columns"},{"title":"Count the tables that spent credits","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-table/length/","href":"/api-reference/credits/count-the-tables-that-spent-credits"},{"title":"Get one table's per-column credit usage","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-table/{table_id}/by-column/","href":"/api-reference/credits/get-one-tables-per-column-credit-usage"},{"title":"List one table's per-run credit usage","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-table/{table_id}/by-run/","href":"/api-reference/credits/list-one-tables-per-run-credit-usage"},{"title":"Count one table's runs that spent credits","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-table/{table_id}/by-run/length/","href":"/api-reference/credits/count-one-tables-runs-that-spent-credits"},{"title":"Get one table's spend series","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/by-table/{table_id}/timeseries/","href":"/api-reference/credits/get-one-tables-spend-series"},{"title":"Export a usage report as CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/export/","href":"/api-reference/credits/export-a-usage-report-as-csv"},{"title":"Get usage history boundaries","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/meta/","href":"/api-reference/credits/get-usage-history-boundaries"},{"title":"Get the credits-spent series","deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage/spend-timeseries/","href":"/api-reference/credits/get-the-credits-spent-series"}]},{"group":"design-partner","pages":[{"title":"List the workspace's design partner feedback","deprecated":null,"version":null,"openapi":"/openapi.json get /design-partner/feedback/","href":"/api-reference/design-partner/list-the-workspaces-design-partner-feedback"},{"title":"Send design partner feedback","deprecated":null,"version":null,"openapi":"/openapi.json post /design-partner/feedback/","href":"/api-reference/design-partner/send-design-partner-feedback"},{"title":"Send the workspace's shared Slack channel invite","deprecated":null,"version":null,"openapi":"/openapi.json post /design-partner/slack-channel/invite/","href":"/api-reference/design-partner/send-the-workspaces-shared-slack-channel-invite"},{"title":"Is this workspace a design partner?","deprecated":null,"version":null,"openapi":"/openapi.json get /design-partner/status/","href":"/api-reference/design-partner/is-this-workspace-a-design-partner?"}]},{"group":"suppression","pages":[{"title":"List do-not-contact entries","deprecated":null,"version":null,"openapi":"/openapi.json get /do-not-contact/","href":"/api-reference/suppression/list-do-not-contact-entries"},{"title":"Delete do-not-contact entries","deprecated":null,"version":null,"openapi":"/openapi.json delete /do-not-contact/","href":"/api-reference/suppression/delete-do-not-contact-entries"},{"title":"Add do-not-contact entries","deprecated":null,"version":null,"openapi":"/openapi.json post /do-not-contact/bulk/","href":"/api-reference/suppression/add-do-not-contact-entries"},{"title":"Preview adding do-not-contact entries","deprecated":null,"version":null,"openapi":"/openapi.json post /do-not-contact/bulk/preview/","href":"/api-reference/suppression/preview-adding-do-not-contact-entries"},{"title":"Export the do-not-contact list","deprecated":null,"version":null,"openapi":"/openapi.json get /do-not-contact/export/","href":"/api-reference/suppression/export-the-do-not-contact-list"},{"title":"Count do-not-contact entries","deprecated":null,"version":null,"openapi":"/openapi.json get /do-not-contact/length/","href":"/api-reference/suppression/count-do-not-contact-entries"}]},{"group":"google-drive","pages":[{"title":"Get the Google Drive connection","deprecated":null,"version":null,"openapi":"/openapi.json get /google-drive/connection/","href":"/api-reference/google-drive/get-the-google-drive-connection"},{"title":"Disconnect Google Drive","deprecated":null,"version":null,"openapi":"/openapi.json delete /google-drive/connection/","href":"/api-reference/google-drive/disconnect-google-drive"},{"title":"Begin connecting Google Drive","deprecated":null,"version":null,"openapi":"/openapi.json post /google-drive/connection/authorize/","href":"/api-reference/google-drive/begin-connecting-google-drive"},{"title":"Finish connecting Google Drive","deprecated":null,"version":null,"openapi":"/openapi.json post /google-drive/connection/callback/","href":"/api-reference/google-drive/finish-connecting-google-drive"},{"title":"Mint a Google Picker token","deprecated":null,"version":null,"openapi":"/openapi.json get /google-drive/connection/picker-token/","href":"/api-reference/google-drive/mint-a-google-picker-token"}]},{"group":"inbox","pages":[{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/attachments/{attachment_id}/download/","href":"/api-reference/inbox/download-an-attachment"},{"title":"Stream the inbox's change events","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/events/","href":"/api-reference/inbox/stream-the-inboxs-change-events"},{"title":"List labels","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/labels/","href":"/api-reference/inbox/list-labels"},{"title":"Create a label","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/labels/","href":"/api-reference/inbox/create-a-label"},{"title":"Delete a label","deprecated":null,"version":null,"openapi":"/openapi.json delete /inbox/labels/{label_id}/","href":"/api-reference/inbox/delete-a-label"},{"title":"Update a label","deprecated":null,"version":null,"openapi":"/openapi.json patch /inbox/labels/{label_id}/","href":"/api-reference/inbox/update-a-label"},{"title":"List saved views","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/saved-views/","href":"/api-reference/inbox/list-saved-views"},{"title":"Save the current filters as a view","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/saved-views/","href":"/api-reference/inbox/save-the-current-filters-as-a-view"},{"title":"Delete a saved view","deprecated":null,"version":null,"openapi":"/openapi.json delete /inbox/saved-views/{view_id}/","href":"/api-reference/inbox/delete-a-saved-view"},{"title":"Rename a saved view or repoint its filters","deprecated":null,"version":null,"openapi":"/openapi.json patch /inbox/saved-views/{view_id}/","href":"/api-reference/inbox/rename-a-saved-view-or-repoint-its-filters"},{"title":"List inbox threads","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/threads/","href":"/api-reference/inbox/list-inbox-threads"},{"title":"Delete many threads","deprecated":null,"version":null,"openapi":"/openapi.json delete /inbox/threads/","href":"/api-reference/inbox/delete-many-threads"},{"title":"Mark many threads read, done or snoozed","deprecated":null,"version":null,"openapi":"/openapi.json patch /inbox/threads/bulk/","href":"/api-reference/inbox/mark-many-threads-read-done-or-snoozed"},{"title":"Put one label on many threads","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/bulk/label/","href":"/api-reference/inbox/put-one-label-on-many-threads"},{"title":"Suppress many threads' contacts at once","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/bulk/suppress/","href":"/api-reference/inbox/suppress-many-threads-contacts-at-once"},{"title":"Count inbox threads","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/threads/length/","href":"/api-reference/inbox/count-inbox-threads"},{"title":"Get one thread","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/threads/{thread_id}/","href":"/api-reference/inbox/get-one-thread"},{"title":"Delete a thread","deprecated":null,"version":null,"openapi":"/openapi.json delete /inbox/threads/{thread_id}/","href":"/api-reference/inbox/delete-a-thread"},{"title":"Mark a thread read, done or snoozed","deprecated":null,"version":null,"openapi":"/openapi.json patch /inbox/threads/{thread_id}/","href":"/api-reference/inbox/mark-a-thread-read-done-or-snoozed"},{"title":"Assign exactly this set of labels to a thread","deprecated":null,"version":null,"openapi":"/openapi.json put /inbox/threads/{thread_id}/labels/","href":"/api-reference/inbox/assign-exactly-this-set-of-labels-to-a-thread"},{"title":"A thread's messages, oldest-first","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/threads/{thread_id}/messages/","href":"/api-reference/inbox/a-threads-messages-oldest-first"},{"title":"Reply in a thread","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/messages/","href":"/api-reference/inbox/reply-in-a-thread"},{"title":"Forward a message to somebody else","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/messages/{message_id}/forward/","href":"/api-reference/inbox/forward-a-message-to-somebody-else"},{"title":"Undo what a reply the AI read as asking to stop did","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/messages/{message_id}/stop-request/revert/","href":"/api-reference/inbox/undo-what-a-reply-the-ai-read-as-asking-to-stop-did"},{"title":"Suppress this contact and stop their sequences","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/suppress/","href":"/api-reference/inbox/suppress-this-contact-and-stop-their-sequences"},{"title":"Resume the follow-ups a reply the AI could not read stopped","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/unread-reply/resume/","href":"/api-reference/inbox/resume-the-follow-ups-a-reply-the-ai-could-not-read-stopped"},{"title":"Have the AI read again a reply it could not read","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/unread-reply/retry/","href":"/api-reference/inbox/have-the-ai-read-again-a-reply-it-could-not-read"}]},{"group":"inbox-ai","pages":[{"title":"List reply drafts","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/drafts/","href":"/api-reference/inbox-ai/list-reply-drafts"},{"title":"Generate a reply draft","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/drafts/","href":"/api-reference/inbox-ai/generate-a-reply-draft"},{"title":"Generate a reply draft, streaming the work","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/drafts/stream/","href":"/api-reference/inbox-ai/generate-a-reply-draft-streaming-the-work"},{"title":"Edit a draft before approving it","deprecated":null,"version":null,"openapi":"/openapi.json patch /inbox/drafts/{draft_id}/","href":"/api-reference/inbox-ai/edit-a-draft-before-approving-it"},{"title":"Approve and send a draft","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/drafts/{draft_id}/approve/","href":"/api-reference/inbox-ai/approve-and-send-a-draft"},{"title":"Rate a draft","deprecated":null,"version":null,"openapi":"/openapi.json put /inbox/drafts/{draft_id}/feedback/","href":"/api-reference/inbox-ai/rate-a-draft"},{"title":"Try again","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/drafts/{draft_id}/regenerate/","href":"/api-reference/inbox-ai/try-again"},{"title":"Reject a draft","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/drafts/{draft_id}/reject/","href":"/api-reference/inbox-ai/reject-a-draft"},{"title":"Whether to show the notice that replies now wait","deprecated":null,"version":null,"openapi":"/openapi.json get /inbox/replies-wait-notice/","href":"/api-reference/inbox-ai/whether-to-show-the-notice-that-replies-now-wait"},{"title":"Close the notice that replies now wait","deprecated":null,"version":null,"openapi":"/openapi.json patch /inbox/replies-wait-notice/","href":"/api-reference/inbox-ai/close-the-notice-that-replies-now-wait"},{"title":"Answer the agent's questions on a reply","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/answers/","href":"/api-reference/inbox-ai/answer-the-agents-questions-on-a-reply"},{"title":"Have the agent write a reply it wrote no draft for","deprecated":null,"version":null,"openapi":"/openapi.json post /inbox/threads/{thread_id}/blocked-reply/retry/","href":"/api-reference/inbox-ai/have-the-agent-write-a-reply-it-wrote-no-draft-for"}]},{"group":"integrations","pages":[{"title":"List all integrations","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/","href":"/api-reference/integrations/list-all-integrations"},{"title":"Bulk delete integrations","deprecated":null,"version":null,"openapi":"/openapi.json delete /integrations/","href":"/api-reference/integrations/bulk-delete-integrations"},{"title":"Bulk trigger health checks","deprecated":null,"version":null,"openapi":"/openapi.json post /integrations/bulk/verify/","href":"/api-reference/integrations/bulk-trigger-health-checks"},{"title":"Get the number of integrations","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/length/","href":"/api-reference/integrations/get-the-number-of-integrations"},{"title":"Suggest an integration name","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/name/suggestions/","href":"/api-reference/integrations/suggest-an-integration-name"},{"title":"Bulk health check progress and summary","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/runs/{run_id}/","href":"/api-reference/integrations/bulk-health-check-progress-and-summary"},{"title":"Get an integration","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/{integration_id}/","href":"/api-reference/integrations/get-an-integration"},{"title":"Delete an integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /integrations/{integration_id}/","href":"/api-reference/integrations/delete-an-integration"},{"title":"List audit logs for an integration","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/{integration_id}/audit-logs/","href":"/api-reference/integrations/list-audit-logs-for-an-integration"},{"title":"List health check history","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/{integration_id}/health-checks/","href":"/api-reference/integrations/list-health-check-history"},{"title":"List all known properties for an integration","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/{integration_id}/properties/","href":"/api-reference/integrations/list-all-known-properties-for-an-integration"},{"title":"List record types for an integration","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/{integration_id}/record-types/","href":"/api-reference/integrations/list-record-types-for-an-integration"},{"title":"Trigger a health check","deprecated":null,"version":null,"openapi":"/openapi.json post /integrations/{integration_id}/verify/","href":"/api-reference/integrations/trigger-a-health-check"}]},{"group":"integration-types","pages":[{"title":"List integration categories","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/categories/","href":"/api-reference/integration-types/list-integration-categories"},{"title":"Count integration categories","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/categories/length/","href":"/api-reference/integration-types/count-integration-categories"},{"title":"List the record-type vocabulary","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/record-types/","href":"/api-reference/integration-types/list-the-record-type-vocabulary"},{"title":"List all available integration types","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/types/","href":"/api-reference/integration-types/list-all-available-integration-types"},{"title":"Get a specific integration type","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/types/{name}/","href":"/api-reference/integration-types/get-a-specific-integration-type"},{"title":"Get setup guide for an integration type","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/types/{name}/guide/","href":"/api-reference/integration-types/get-setup-guide-for-an-integration-type"}]},{"group":"table-integration-lookup","pages":[{"title":"List the fields one record type can be looked up by","deprecated":null,"version":null,"openapi":"/openapi.json get /integrations/{integration_id}/identity-fields/","href":"/api-reference/table-integration-lookup/list-the-fields-one-record-type-can-be-looked-up-by"}]},{"group":"find-leads","pages":[{"title":"List the columns a search would create","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/columns/","href":"/api-reference/find-leads/list-the-columns-a-search-would-create"},{"title":"Read a table of companies a people search can follow","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/company-table/","href":"/api-reference/find-leads/read-a-table-of-companies-a-people-search-can-follow"},{"title":"List the enrichments offered at import","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/enrichment-options/","href":"/api-reference/find-leads/list-the-enrichments-offered-at-import"},{"title":"Count matching leads","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/length/","href":"/api-reference/find-leads/count-matching-leads"},{"title":"Find an address on the map","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/places/search/","href":"/api-reference/find-leads/find-an-address-on-the-map"},{"title":"Preview matching leads","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/preview/","href":"/api-reference/find-leads/preview-matching-leads"},{"title":"List recorded lead searches","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/recent-searches/","href":"/api-reference/find-leads/list-recorded-lead-searches"},{"title":"Remove a search from your recents","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/recent-searches/{entry_id}/","href":"/api-reference/find-leads/remove-a-search-from-your-recents"},{"title":"Get a search type's row price","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/record-types/{record_type}/","href":"/api-reference/find-leads/get-a-search-types-row-price"},{"title":"List saved lead searches","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/saved-searches/","href":"/api-reference/find-leads/list-saved-lead-searches"},{"title":"Save a lead search","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/saved-searches/","href":"/api-reference/find-leads/save-a-lead-search"},{"title":"Suggest starter lead searches","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/saved-searches/suggestions/","href":"/api-reference/find-leads/suggest-starter-lead-searches"},{"title":"Delete a saved lead search","deprecated":null,"version":null,"openapi":"/openapi.json delete /leads/saved-searches/{saved_search_id}/","href":"/api-reference/find-leads/delete-a-saved-lead-search"},{"title":"Record a saved search being loaded","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/saved-searches/{saved_search_id}/open/","href":"/api-reference/find-leads/record-a-saved-search-being-loaded"},{"title":"List the buying signals a search can look for","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/signal-types/","href":"/api-reference/find-leads/list-the-buying-signals-a-search-can-look-for"},{"title":"List the accelerator batches","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/startup-launches/batches/","href":"/api-reference/find-leads/list-the-accelerator-batches"},{"title":"List the startup launch filters","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/startup-launches/filters/","href":"/api-reference/find-leads/list-the-startup-launch-filters"},{"title":"List the startup launch boards","deprecated":null,"version":null,"openapi":"/openapi.json get /leads/startup-launches/sources/","href":"/api-reference/find-leads/list-the-startup-launch-boards"},{"title":"Suggest a name for a lead search's table","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/table-name/suggestions/","href":"/api-reference/find-leads/suggest-a-name-for-a-lead-searchs-table"},{"title":"Match pasted values against a closed vocabulary","deprecated":null,"version":null,"openapi":"/openapi.json post /leads/vocabulary/suggestions/","href":"/api-reference/find-leads/match-pasted-values-against-a-closed-vocabulary"},{"title":"Get the search behind a table","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/lead-search/","href":"/api-reference/find-leads/get-the-search-behind-a-table"},{"title":"Put a lead search behind a table","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/lead-search/","href":"/api-reference/find-leads/put-a-lead-search-behind-a-table"},{"title":"Remove a table's search","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/lead-search/","href":"/api-reference/find-leads/remove-a-tables-search"},{"title":"Preview replacing a table's rows with its search","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/lead-search/impact/","href":"/api-reference/find-leads/preview-replacing-a-tables-rows-with-its-search"},{"title":"Preview putting a search behind a table","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/lead-search/preview/","href":"/api-reference/find-leads/preview-putting-a-search-behind-a-table"},{"title":"List a table's search runs","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/lead-search/runs/","href":"/api-reference/find-leads/list-a-tables-search-runs"},{"title":"Run a table's search again","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/lead-search/runs/","href":"/api-reference/find-leads/run-a-tables-search-again"},{"title":"Preview a run of a table's search","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/lead-search/runs/preview/","href":"/api-reference/find-leads/preview-a-run-of-a-tables-search"},{"title":"Set a search's run cadence","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/lead-search/schedule/","href":"/api-reference/find-leads/set-a-searchs-run-cadence"},{"title":"Clear a search's run cadence","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/lead-search/schedule/","href":"/api-reference/find-leads/clear-a-searchs-run-cadence"}]},{"group":"linkedin","pages":[{"title":"Claim the next permitted action","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/next/","href":"/api-reference/linkedin/claim-the-next-permitted-action"},{"title":"Report a run of a step that was cut off, and ask what to do with the step","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/{action_id}/attempts/","href":"/api-reference/linkedin/report-a-run-of-a-step-that-was-cut-off-and-ask-what-to-do-with-the-step"},{"title":"Ask to press the control that changes LinkedIn","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/{action_id}/commit/","href":"/api-reference/linkedin/ask-to-press-the-control-that-changes-linkedin"},{"title":"Attach a page snapshot to a step's report","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/{action_id}/diagnostic/","href":"/api-reference/linkedin/attach-a-page-snapshot-to-a-steps-report"},{"title":"Skip a step from the side panel","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/{action_id}/reject/","href":"/api-reference/linkedin/skip-a-step-from-the-side-panel"},{"title":"Hand back a running step without settling it","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/{action_id}/release/","href":"/api-reference/linkedin/hand-back-a-running-step-without-settling-it"},{"title":"Report an action's outcome","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/actions/{action_id}/result/","href":"/api-reference/linkedin/report-an-actions-outcome"},{"title":"Fetch the remote selector and pacing config","deprecated":null,"version":null,"openapi":"/openapi.json get /linkedin/agent/config/","href":"/api-reference/linkedin/fetch-the-remote-selector-and-pacing-config"},{"title":"Disconnect the account from the side panel","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/disconnect/","href":"/api-reference/linkedin/disconnect-the-account-from-the-side-panel"},{"title":"Report liveness and read the authoritative run state","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/heartbeat/","href":"/api-reference/linkedin/report-liveness-and-read-the-authoritative-run-state"},{"title":"List completed steps, for the side panel","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/history/","href":"/api-reference/linkedin/list-completed-steps-for-the-side-panel"},{"title":"Connect a browser with a sender's connection token","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/pair/","href":"/api-reference/linkedin/connect-a-browser-with-a-senders-connection-token"},{"title":"List the queue, for the side panel","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/queue/","href":"/api-reference/linkedin/list-the-queue-for-the-side-panel"},{"title":"Set the sender's approval setting from the extension","deprecated":null,"version":null,"openapi":"/openapi.json post /linkedin/agent/state/","href":"/api-reference/linkedin/set-the-senders-approval-setting-from-the-extension"},{"title":"List a sender's LinkedIn steps","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/linkedin/actions/","href":"/api-reference/linkedin/list-a-senders-linkedin-steps"},{"title":"Try one LinkedIn step","deprecated":null,"version":null,"openapi":"/openapi.json post /sender-profiles/{profile_id}/linkedin/actions/","href":"/api-reference/linkedin/try-one-linkedin-step"},{"title":"Count a sender's LinkedIn steps","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/linkedin/actions/length/","href":"/api-reference/linkedin/count-a-senders-linkedin-steps"},{"title":"Cancel a queued LinkedIn step","deprecated":null,"version":null,"openapi":"/openapi.json post /sender-profiles/{profile_id}/linkedin/actions/{action_id}/cancel/","href":"/api-reference/linkedin/cancel-a-queued-linkedin-step"},{"title":"Read a sender's LinkedIn connection","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/linkedin/connection/","href":"/api-reference/linkedin/read-a-senders-linkedin-connection"},{"title":"Disconnect the sender's LinkedIn account","deprecated":null,"version":null,"openapi":"/openapi.json delete /sender-profiles/{profile_id}/linkedin/connection/","href":"/api-reference/linkedin/disconnect-the-senders-linkedin-account"},{"title":"Replace the sender's connection token","deprecated":null,"version":null,"openapi":"/openapi.json post /sender-profiles/{profile_id}/linkedin/connection/regenerate-token/","href":"/api-reference/linkedin/replace-the-senders-connection-token"},{"title":"Stream a sender's LinkedIn changes","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/linkedin/events/","href":"/api-reference/linkedin/stream-a-senders-linkedin-changes"},{"title":"Update LinkedIn safety settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /sender-profiles/{profile_id}/linkedin/settings/","href":"/api-reference/linkedin/update-linkedin-safety-settings"},{"title":"Read a sender's LinkedIn step totals","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/linkedin/stats/","href":"/api-reference/linkedin/read-a-senders-linkedin-step-totals"},{"title":"Count a sender's LinkedIn steps that tables queued","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/linkedin/table-steps/","href":"/api-reference/linkedin/count-a-senders-linkedin-steps-that-tables-queued"},{"title":"Cancel a table column's queued LinkedIn steps","deprecated":null,"version":null,"openapi":"/openapi.json post /sender-profiles/{profile_id}/linkedin/table-steps/bulk/cancel/","href":"/api-reference/linkedin/cancel-a-table-columns-queued-linkedin-steps"}]},{"group":"senders","pages":[{"title":"List mailboxes","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/","href":"/api-reference/senders/list-mailboxes"},{"title":"Delete many mailboxes","deprecated":null,"version":null,"openapi":"/openapi.json delete /mailboxes/","href":"/api-reference/senders/delete-many-mailboxes"},{"title":"Begin connecting a Google Workspace mailbox","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/authorize/","href":"/api-reference/senders/begin-connecting-a-google-workspace-mailbox"},{"title":"Edit many mailboxes at once","deprecated":null,"version":null,"openapi":"/openapi.json patch /mailboxes/bulk/","href":"/api-reference/senders/edit-many-mailboxes-at-once"},{"title":"Re-check mailbox connections now","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/bulk/verify/","href":"/api-reference/senders/re-check-mailbox-connections-now"},{"title":"Finish connecting a Google Workspace mailbox","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/callback/","href":"/api-reference/senders/finish-connecting-a-google-workspace-mailbox"},{"title":"Get the InboxKit connection state","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/inboxkit/connection/","href":"/api-reference/senders/get-the-inboxkit-connection-state"},{"title":"Connect InboxKit","deprecated":null,"version":null,"openapi":"/openapi.json put /mailboxes/inboxkit/connection/","href":"/api-reference/senders/connect-inboxkit"},{"title":"Disconnect InboxKit","deprecated":null,"version":null,"openapi":"/openapi.json delete /mailboxes/inboxkit/connection/","href":"/api-reference/senders/disconnect-inboxkit"},{"title":"Update InboxKit automation settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /mailboxes/inboxkit/connection/","href":"/api-reference/senders/update-inboxkit-automation-settings"},{"title":"Validate an InboxKit API key and list its workspaces","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/inboxkit/connection/preview/","href":"/api-reference/senders/validate-an-inboxkit-api-key-and-list-its-workspaces"},{"title":"List domain delegation states","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/inboxkit/domains/","href":"/api-reference/senders/list-domain-delegation-states"},{"title":"List InboxKit import runs","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/inboxkit/imports/","href":"/api-reference/senders/list-inboxkit-import-runs"},{"title":"Import selected InboxKit mailboxes","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/inboxkit/imports/","href":"/api-reference/senders/import-selected-inboxkit-mailboxes"},{"title":"Get one InboxKit import run","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/inboxkit/imports/{run_id}/","href":"/api-reference/senders/get-one-inboxkit-import-run"},{"title":"List the org's InboxKit inventory","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/inboxkit/inventory/","href":"/api-reference/senders/list-the-orgs-inboxkit-inventory"},{"title":"Count mailboxes","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/length/","href":"/api-reference/senders/count-mailboxes"},{"title":"Whether Outlook can connect, and the person's admin approval","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/microsoft/","href":"/api-reference/senders/whether-outlook-can-connect-and-the-persons-admin-approval"},{"title":"Record a Microsoft 365 admin's approval","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/microsoft/admin-approved/","href":"/api-reference/senders/record-a-microsoft-365-admins-approval"},{"title":"Ask your Microsoft 365 admin to approve Oneprofile","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/microsoft/approval/","href":"/api-reference/senders/ask-your-microsoft-365-admin-to-approve-oneprofile"},{"title":"Connect the Outlook mailbox of your Microsoft sign-in","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/microsoft/connect/","href":"/api-reference/senders/connect-the-outlook-mailbox-of-your-microsoft-sign-in"},{"title":"Connect one mailbox of a connected Microsoft 365 organization","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/microsoft/fleet/","href":"/api-reference/senders/connect-one-mailbox-of-a-connected-microsoft-365-organization"},{"title":"List the Microsoft 365 organizations connected here","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/microsoft/tenants/","href":"/api-reference/senders/list-the-microsoft-365-organizations-connected-here"},{"title":"Begin connecting a whole Microsoft 365 organization","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/microsoft/tenants/authorize/","href":"/api-reference/senders/begin-connecting-a-whole-microsoft-365-organization"},{"title":"Finish connecting a Microsoft 365 organization","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/microsoft/tenants/callback/","href":"/api-reference/senders/finish-connecting-a-microsoft-365-organization"},{"title":"Mailbox overview tiles","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/overview/","href":"/api-reference/senders/mailbox-overview-tiles"},{"title":"Get a mailbox","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/{mailbox_id}/","href":"/api-reference/senders/get-a-mailbox"},{"title":"Delete a mailbox","deprecated":null,"version":null,"openapi":"/openapi.json delete /mailboxes/{mailbox_id}/","href":"/api-reference/senders/delete-a-mailbox"},{"title":"Update a mailbox","deprecated":null,"version":null,"openapi":"/openapi.json patch /mailboxes/{mailbox_id}/","href":"/api-reference/senders/update-a-mailbox"},{"title":"A mailbox's recent sends, replies and bounces","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/{mailbox_id}/activity/","href":"/api-reference/senders/a-mailboxs-recent-sends-replies-and-bounces"},{"title":"List a mailbox's bounces","deprecated":null,"version":null,"openapi":"/openapi.json get /mailboxes/{mailbox_id}/bounces/","href":"/api-reference/senders/list-a-mailboxs-bounces"},{"title":"Verify a mailbox's connection still works","deprecated":null,"version":null,"openapi":"/openapi.json post /mailboxes/{mailbox_id}/verify/","href":"/api-reference/senders/verify-a-mailboxs-connection-still-works"},{"title":"List senders","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/","href":"/api-reference/senders/list-senders"},{"title":"Add a sender","deprecated":null,"version":null,"openapi":"/openapi.json post /sender-profiles/","href":"/api-reference/senders/add-a-sender"},{"title":"Delete many senders","deprecated":null,"version":null,"openapi":"/openapi.json delete /sender-profiles/","href":"/api-reference/senders/delete-many-senders"},{"title":"Edit many senders at once","deprecated":null,"version":null,"openapi":"/openapi.json patch /sender-profiles/bulk/","href":"/api-reference/senders/edit-many-senders-at-once"},{"title":"Get a sender","deprecated":null,"version":null,"openapi":"/openapi.json get /sender-profiles/{profile_id}/","href":"/api-reference/senders/get-a-sender"},{"title":"Delete a sender","deprecated":null,"version":null,"openapi":"/openapi.json delete /sender-profiles/{profile_id}/","href":"/api-reference/senders/delete-a-sender"},{"title":"Update a sender","deprecated":null,"version":null,"openapi":"/openapi.json patch /sender-profiles/{profile_id}/","href":"/api-reference/senders/update-a-sender"},{"title":"Set a profile's mailboxes","deprecated":null,"version":null,"openapi":"/openapi.json put /sender-profiles/{profile_id}/mailboxes/","href":"/api-reference/senders/set-a-profiles-mailboxes"}]},{"group":"sequences","pages":[{"title":"List saved email templates","deprecated":null,"version":null,"openapi":"/openapi.json get /message-templates/","href":"/api-reference/sequences/list-saved-email-templates"},{"title":"Save an email template","deprecated":null,"version":null,"openapi":"/openapi.json post /message-templates/","href":"/api-reference/sequences/save-an-email-template"},{"title":"List the built-in email templates","deprecated":null,"version":null,"openapi":"/openapi.json get /message-templates/built-ins/","href":"/api-reference/sequences/list-the-built-in-email-templates"},{"title":"Delete an email template","deprecated":null,"version":null,"openapi":"/openapi.json delete /message-templates/{template_id}/","href":"/api-reference/sequences/delete-an-email-template"},{"title":"Rename or re-scope an email template","deprecated":null,"version":null,"openapi":"/openapi.json patch /message-templates/{template_id}/","href":"/api-reference/sequences/rename-or-re-scope-an-email-template"},{"title":"List reusable sequence templates","deprecated":null,"version":null,"openapi":"/openapi.json get /sequence-templates/","href":"/api-reference/sequences/list-reusable-sequence-templates"},{"title":"Save a detached sequence template","deprecated":null,"version":null,"openapi":"/openapi.json post /sequence-templates/","href":"/api-reference/sequences/save-a-detached-sequence-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequence-templates/{template_id}/","href":"/api-reference/sequences/delete-a-template"},{"title":"Create a draft from a template, with fresh audience and senders","deprecated":null,"version":null,"openapi":"/openapi.json post /sequence-templates/{template_id}/use/","href":"/api-reference/sequences/create-a-draft-from-a-template-with-fresh-audience-and-senders"},{"title":"List sequences","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/","href":"/api-reference/sequences/list-sequences"},{"title":"Create a sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/","href":"/api-reference/sequences/create-a-sequence"},{"title":"Sender leaderboard","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/analytics/leaderboard/","href":"/api-reference/sequences/sender-leaderboard"},{"title":"Outreach analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/analytics/summary/","href":"/api-reference/sequences/outreach-analytics"},{"title":"Name the tables a sequence cannot write to","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/audience-refusals/","href":"/api-reference/sequences/name-the-tables-a-sequence-cannot-write-to"},{"title":"Change several sequences at once","deprecated":null,"version":null,"openapi":"/openapi.json patch /sequences/bulk/","href":"/api-reference/sequences/change-several-sequences-at-once"},{"title":"Suggest a column mapping for a table","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/column-mapping/suggestions/","href":"/api-reference/sequences/suggest-a-column-mapping-for-a-table"},{"title":"Suggest email steps from a table's written emails","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/email-steps/suggestions/","href":"/api-reference/sequences/suggest-email-steps-from-a-tables-written-emails"},{"title":"List sequence folders","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/folders/","href":"/api-reference/sequences/list-sequence-folders"},{"title":"Make a sequence folder","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/folders/","href":"/api-reference/sequences/make-a-sequence-folder"},{"title":"Suggest folders for the sequences in no folder","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/folders/suggestions/","href":"/api-reference/sequences/suggest-folders-for-the-sequences-in-no-folder"},{"title":"Delete a sequence folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequences/folders/{folder_id}/","href":"/api-reference/sequences/delete-a-sequence-folder"},{"title":"Rename or move a sequence folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /sequences/folders/{folder_id}/","href":"/api-reference/sequences/rename-or-move-a-sequence-folder"},{"title":"Restore a sequence folder from Trash","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/folders/{folder_id}/restore/","href":"/api-reference/sequences/restore-a-sequence-folder-from-trash"},{"title":"Count sequences, with when their stats were computed","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/length/","href":"/api-reference/sequences/count-sequences-with-when-their-stats-were-computed"},{"title":"Check a drafted message for deliverability risks","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/message/check/","href":"/api-reference/sequences/check-a-drafted-message-for-deliverability-risks"},{"title":"Propose spintax rotations for a drafted message","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/spintax/suggestions/","href":"/api-reference/sequences/propose-spintax-rotations-for-a-drafted-message"},{"title":"Get a sequence with its graph","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/","href":"/api-reference/sequences/get-a-sequence-with-its-graph"},{"title":"Move a sequence to Trash","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequences/{sequence_id}/","href":"/api-reference/sequences/move-a-sequence-to-trash"},{"title":"Update a sequence's settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /sequences/{sequence_id}/","href":"/api-reference/sequences/update-a-sequences-settings"},{"title":"Copy another sequence's agent setup","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/copy/","href":"/api-reference/sequences/copy-another-sequences-agent-setup"},{"title":"List saved samples or reviewed messages for a sequence's agent","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/agent/examples/","href":"/api-reference/sequences/list-saved-samples-or-reviewed-messages-for-a-sequences-agent"},{"title":"Preview one contact's agent-written message, streaming the research","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/preview/stream/","href":"/api-reference/sequences/preview-one-contacts-agent-written-message-streaming-the-research"},{"title":"Stop a preview that is being written","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/preview/{preview_id}/stop/","href":"/api-reference/sequences/stop-a-preview-that-is-being-written"},{"title":"List the audience columns the agent writes from","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/agent/source-columns/","href":"/api-reference/sequences/list-the-audience-columns-the-agent-writes-from"},{"title":"List contacts available for the Preview","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/agent/training-contacts/","href":"/api-reference/sequences/list-contacts-available-for-the-preview"},{"title":"Keep threads already written in the sequence's Preview","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/training-contacts/bulk/","href":"/api-reference/sequences/keep-threads-already-written-in-the-sequences-preview"},{"title":"Name the contact to read after this one","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/agent/training-contacts/next/","href":"/api-reference/sequences/name-the-contact-to-read-after-this-one"},{"title":"List the sequence's Previews","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/agent/training-sessions/","href":"/api-reference/sequences/list-the-sequences-previews"},{"title":"Write complete sequences for up to ten contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/training-sessions/","href":"/api-reference/sequences/write-complete-sequences-for-up-to-ten-contacts"},{"title":"Close the Preview and keep its reviews","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/training-sessions/{session_id}/complete/","href":"/api-reference/sequences/close-the-preview-and-keep-its-reviews"},{"title":"Review a contact's whole thread in the Preview","deprecated":null,"version":null,"openapi":"/openapi.json patch /sequences/{sequence_id}/agent/training-sessions/{session_id}/contacts/{record_id}/","href":"/api-reference/sequences/review-a-contacts-whole-thread-in-the-preview"},{"title":"Write the Preview's failed messages again","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/agent/training-sessions/{session_id}/retry/","href":"/api-reference/sequences/write-the-previews-failed-messages-again"},{"title":"Set the audience: table, view, column mapping","deprecated":null,"version":null,"openapi":"/openapi.json put /sequences/{sequence_id}/audience/","href":"/api-reference/sequences/set-the-audience:-table-view-column-mapping"},{"title":"Remap the audience columns without rebinding the table","deprecated":null,"version":null,"openapi":"/openapi.json patch /sequences/{sequence_id}/audience/","href":"/api-reference/sequences/remap-the-audience-columns-without-rebinding-the-table"},{"title":"Preview a replacement audience before choosing how existing journeys continue","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/audience/impact/","href":"/api-reference/sequences/preview-a-replacement-audience-before-choosing-how-existing-journeys-continue"},{"title":"Preview what the audience resolves to","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/audience/preview/","href":"/api-reference/sequences/preview-what-the-audience-resolves-to"},{"title":"List a sequence's activity","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/audit-logs/","href":"/api-reference/sequences/list-a-sequences-activity"},{"title":"A Browser use run's recording","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/browser-runs/{run_id}/replay/","href":"/api-reference/sequences/a-browser-use-runs-recording"},{"title":"Open a Browser use run's recording","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/browser-runs/{run_id}/replay/open/","href":"/api-reference/sequences/open-a-browser-use-runs-recording"},{"title":"One page of a Browser use run's recording, as a playlist","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/browser-runs/{run_id}/replay/pages/{page_id}/download/","href":"/api-reference/sequences/one-page-of-a-browser-use-runs-recording-as-a-playlist"},{"title":"Show the values a Browser use run kept out of sight","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/browser-runs/{run_id}/reveal/","href":"/api-reference/sequences/show-the-values-a-browser-use-run-kept-out-of-sight"},{"title":"A Browser use trial's recording","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/browser-trials/{trial_id}/replay/","href":"/api-reference/sequences/a-browser-use-trials-recording"},{"title":"Open a Browser use trial's recording","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/browser-trials/{trial_id}/replay/open/","href":"/api-reference/sequences/open-a-browser-use-trials-recording"},{"title":"One page of a Browser use trial's recording, as a playlist","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/browser-trials/{trial_id}/replay/pages/{page_id}/download/","href":"/api-reference/sequences/one-page-of-a-browser-use-trials-recording-as-a-playlist"},{"title":"Show the values a Browser use trial kept out of sight","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/browser-trials/{trial_id}/reveal/","href":"/api-reference/sequences/show-the-values-a-browser-use-trial-kept-out-of-sight"},{"title":"Read sequence spending and reservations","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/budget/","href":"/api-reference/sequences/read-sequence-spending-and-reservations"},{"title":"Get the combined send capacity of the sequence's assigned senders","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/capacity/","href":"/api-reference/sequences/get-the-combined-send-capacity-of-the-sequences-assigned-senders"},{"title":"Apply the reviewed changes atomically","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/changes/apply/","href":"/api-reference/sequences/apply-the-reviewed-changes-atomically"},{"title":"Review proposed live changes","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/changes/preview/","href":"/api-reference/sequences/review-proposed-live-changes"},{"title":"Check a sequence before it launches","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/check/","href":"/api-reference/sequences/check-a-sequence-before-it-launches"},{"title":"List a sequence's contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/contacts/","href":"/api-reference/sequences/list-a-sequences-contacts"},{"title":"Remove many contacts from the sequence","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequences/{sequence_id}/contacts/","href":"/api-reference/sequences/remove-many-contacts-from-the-sequence"},{"title":"Contacts breakdown","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/contacts/breakdown/","href":"/api-reference/sequences/contacts-breakdown"},{"title":"Pause many contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/bulk/pause/","href":"/api-reference/sequences/pause-many-contacts"},{"title":"Resume many contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/bulk/resume/","href":"/api-reference/sequences/resume-many-contacts"},{"title":"Retry many failed contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/bulk/retry/","href":"/api-reference/sequences/retry-many-failed-contacts"},{"title":"Send the next step now to many contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/bulk/send-now/","href":"/api-reference/sequences/send-the-next-step-now-to-many-contacts"},{"title":"Stop many contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/bulk/stop/","href":"/api-reference/sequences/stop-many-contacts"},{"title":"Audience eligibility and actionable reasons","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/contacts/eligibility/","href":"/api-reference/sequences/audience-eligibility-and-actionable-reasons"},{"title":"Count the contacts a filter matches under each tab","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/contacts/length/","href":"/api-reference/sequences/count-the-contacts-a-filter-matches-under-each-tab"},{"title":"One contact in this sequence","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/contacts/{enrolment_id}/","href":"/api-reference/sequences/one-contact-in-this-sequence"},{"title":"Remove one contact from the sequence","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequences/{sequence_id}/contacts/{enrolment_id}/","href":"/api-reference/sequences/remove-one-contact-from-the-sequence"},{"title":"One contact's history in this sequence","description":"Everything the sequence did to one contact, oldest first: the emails it sent with their subject and body, the LinkedIn actions it ran with their message, the branch each condition took, and each step it moved them past without doing it, with why (no email address, an email verdict the sequence does not send to, no LinkedIn URL).\n\nAssembled from stores that each remember a different part. The send fence knows an email was accepted and when; the send log knows what it said; the action queue is both at once for LinkedIn; the condition ledger knows which way a branch went, and the skip ledger which steps were passed, because the engine moves the pointer and forgets.\n\nWhere a step went through the approval queue, the entry also says what was decided, when, and by whom, as a name. A rejected email appears only this way: it never reached the send fence.\n\nThe contact's own part is there too: their reply, with what they wrote and the inbox conversation it opens, and the email a bounce came back for. Every filled column of their audience row, and whether the step they wait on will be skipped, are get_sequence_contact's.","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/contacts/{enrolment_id}/history/","href":"/api-reference/sequences/one-contacts-history-in-this-sequence"},{"title":"Move one contact to another sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/{enrolment_id}/move/","href":"/api-reference/sequences/move-one-contact-to-another-sequence"},{"title":"Pause one contact","description":"Holds an in-flight contact exactly where it stands. Paused contacts are never claimed by the engine, keep their step and their one-live-sequence slot, and a reply or unsubscribe still stops them. Valid only for a contact currently active or claimed.","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/{enrolment_id}/pause/","href":"/api-reference/sequences/pause-one-contact"},{"title":"Resume one paused or stopped contact","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/contacts/{enrolment_id}/resume/","href":"/api-reference/sequences/resume-one-paused-or-stopped-contact"},{"title":"Duplicate a sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/duplicate/","href":"/api-reference/sequences/duplicate-a-sequence"},{"title":"Find a sequence's missing work emails","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/email-searches/","href":"/api-reference/sequences/find-a-sequences-missing-work-emails"},{"title":"Price finding a sequence's missing work emails","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/email-searches/preview/","href":"/api-reference/sequences/price-finding-a-sequences-missing-work-emails"},{"title":"Verify a sequence's emails","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/email-verifications/","href":"/api-reference/sequences/verify-a-sequences-emails"},{"title":"Price verifying a sequence's emails","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/email-verifications/preview/","href":"/api-reference/sequences/price-verifying-a-sequences-emails"},{"title":"Follow a sequence's email verification","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/email-verifications/progress/","href":"/api-reference/sequences/follow-a-sequences-email-verification"},{"title":"Star a sequence","deprecated":null,"version":null,"openapi":"/openapi.json put /sequences/{sequence_id}/favorite/","href":"/api-reference/sequences/star-a-sequence"},{"title":"Unstar a sequence","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequences/{sequence_id}/favorite/","href":"/api-reference/sequences/unstar-a-sequence"},{"title":"Live per-node counts for the builder","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/funnel/","href":"/api-reference/sequences/live-per-node-counts-for-the-builder"},{"title":"Replace the sequence graph","deprecated":null,"version":null,"openapi":"/openapi.json put /sequences/{sequence_id}/graph/","href":"/api-reference/sequences/replace-the-sequence-graph"},{"title":"Why nothing is moving","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/holds/","href":"/api-reference/sequences/why-nothing-is-moving"},{"title":"Launch a sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/launch/","href":"/api-reference/sequences/launch-a-sequence"},{"title":"Per-step message performance","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/message-performance/","href":"/api-reference/sequences/per-step-message-performance"},{"title":"What a sequence's contacts have cost so far","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/observed-costs/","href":"/api-reference/sequences/what-a-sequences-contacts-have-cost-so-far"},{"title":"Record that the caller opened this sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/open/","href":"/api-reference/sequences/record-that-the-caller-opened-this-sequence"},{"title":"Pause a sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/pause/","href":"/api-reference/sequences/pause-a-sequence"},{"title":"Reply numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/reply-stats/","href":"/api-reference/sequences/reply-numbers"},{"title":"Restore a sequence from Trash","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/restore/","href":"/api-reference/sequences/restore-a-sequence-from-trash"},{"title":"Resume a paused sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/resume/","href":"/api-reference/sequences/resume-a-paused-sequence"},{"title":"Get the senders a sequence sends as","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/senders/","href":"/api-reference/sequences/get-the-senders-a-sequence-sends-as"},{"title":"Choose the senders a sequence sends as","deprecated":null,"version":null,"openapi":"/openapi.json put /sequences/{sequence_id}/senders/","href":"/api-reference/sequences/choose-the-senders-a-sequence-sends-as"},{"title":"Follow a sequence's start","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/start-progress/","href":"/api-reference/sequences/follow-a-sequences-start"},{"title":"List a Browser use step's trials","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/steps/{step_id}/browser-trials/","href":"/api-reference/sequences/list-a-browser-use-steps-trials"},{"title":"Try a Browser use step on one contact","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/steps/{step_id}/browser-trials/","href":"/api-reference/sequences/try-a-browser-use-step-on-one-contact"},{"title":"Preview trying a Browser use step on one contact","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/steps/{step_id}/browser-trials/preview/","href":"/api-reference/sequences/preview-trying-a-browser-use-step-on-one-contact"},{"title":"Render a step for one contact","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/steps/{step_id}/preview/","href":"/api-reference/sequences/render-a-step-for-one-contact"},{"title":"Preview one step for one contact with the waiting changes","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/steps/{step_id}/preview/","href":"/api-reference/sequences/preview-one-step-for-one-contact-with-the-waiting-changes"},{"title":"Mark one email the agent wrote for a contact Looks good","deprecated":null,"version":null,"openapi":"/openapi.json put /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/feedback/","href":"/api-reference/sequences/mark-one-email-the-agent-wrote-for-a-contact-looks-good"},{"title":"Get one contact's hand-edited message for a step","deprecated":null,"version":null,"openapi":"/openapi.json get /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/override/","href":"/api-reference/sequences/get-one-contacts-hand-edited-message-for-a-step"},{"title":"Pin the exact message one contact receives","deprecated":null,"version":null,"openapi":"/openapi.json put /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/override/","href":"/api-reference/sequences/pin-the-exact-message-one-contact-receives"},{"title":"Revert one contact to the step's template","deprecated":null,"version":null,"openapi":"/openapi.json delete /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/override/","href":"/api-reference/sequences/revert-one-contact-to-the-steps-template"},{"title":"Write one contact's samples","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/steps/{step_id}/rows/{record_id}/samples/","href":"/api-reference/sequences/write-one-contacts-samples"},{"title":"Send this step as a real test email","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/steps/{step_id}/test-send/","href":"/api-reference/sequences/send-this-step-as-a-real-test-email"},{"title":"Sync a sequence's enrolments now","deprecated":null,"version":null,"openapi":"/openapi.json post /sequences/{sequence_id}/sync/","href":"/api-reference/sequences/sync-a-sequences-enrolments-now"},{"title":"Add grid rows to a sequence","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/bulk/add-to-sequence/","href":"/api-reference/sequences/add-grid-rows-to-a-sequence"}]},{"group":"notifications","pages":[{"title":"This user's notification switches","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/preferences/","href":"/api-reference/notifications/this-users-notification-switches"},{"title":"Update this user's notification switches","deprecated":null,"version":null,"openapi":"/openapi.json put /notifications/preferences/","href":"/api-reference/notifications/update-this-users-notification-switches"},{"title":"List notification rules","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/rules/","href":"/api-reference/notifications/list-notification-rules"},{"title":"Create a notification rule","deprecated":null,"version":null,"openapi":"/openapi.json post /notifications/rules/","href":"/api-reference/notifications/create-a-notification-rule"},{"title":"Delete a notification rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /notifications/rules/{rule_id}/","href":"/api-reference/notifications/delete-a-notification-rule"},{"title":"Channels the bot can post to","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/slack/channels/","href":"/api-reference/notifications/channels-the-bot-can-post-to"},{"title":"The organization's Slack connection","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/slack/connection/","href":"/api-reference/notifications/the-organizations-slack-connection"},{"title":"Disconnect Slack","deprecated":null,"version":null,"openapi":"/openapi.json delete /notifications/slack/connection/","href":"/api-reference/notifications/disconnect-slack"},{"title":"Begin connecting a Slack workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /notifications/slack/connection/authorize/","href":"/api-reference/notifications/begin-connecting-a-slack-workspace"},{"title":"Finish connecting a Slack workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /notifications/slack/connection/callback/","href":"/api-reference/notifications/finish-connecting-a-slack-workspace"},{"title":"List the organization's Slack connections","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/slack/connections/","href":"/api-reference/notifications/list-the-organizations-slack-connections"}]},{"group":"onboarding-wizard","pages":[{"title":"Join the Outlook waitlist","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/outlook-waitlist/entries/","href":"/api-reference/onboarding-wizard/join-the-outlook-waitlist"},{"title":"Start a preview for a company","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/","href":"/api-reference/onboarding-wizard/start-a-preview-for-a-company"},{"title":"Read the preview","deprecated":null,"version":null,"openapi":"/openapi.json get /onboarding-wizard/runs/{run_id}/","href":"/api-reference/onboarding-wizard/read-the-preview"},{"title":"Claim the preview after signing in","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/claim/","href":"/api-reference/onboarding-wizard/claim-the-preview-after-signing-in"},{"title":"Give feedback on a first email","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/feedback-requests/","href":"/api-reference/onboarding-wizard/give-feedback-on-a-first-email"},{"title":"Read a feedback request","deprecated":null,"version":null,"openapi":"/openapi.json get /onboarding-wizard/runs/{run_id}/feedback-requests/{request_id}/","href":"/api-reference/onboarding-wizard/read-a-feedback-request"},{"title":"Ask to join the colleagues' workspace","deprecated":null,"version":null,"openapi":"/openapi.json put /onboarding-wizard/runs/{run_id}/join-request/","href":"/api-reference/onboarding-wizard/ask-to-join-the-colleagues-workspace"},{"title":"Start the campaign anyway","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/launch/","href":"/api-reference/onboarding-wizard/start-the-campaign-anyway"},{"title":"Mark a person's messages Looks good","deprecated":null,"version":null,"openapi":"/openapi.json patch /onboarding-wizard/runs/{run_id}/messages/{record_id}/","href":"/api-reference/onboarding-wizard/mark-a-persons-messages-looks-good"},{"title":"Change the free pilot offer","deprecated":null,"version":null,"openapi":"/openapi.json put /onboarding-wizard/runs/{run_id}/offer/","href":"/api-reference/onboarding-wizard/change-the-free-pilot-offer"},{"title":"Try the research again","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/research/retry/","href":"/api-reference/onboarding-wizard/try-the-research-again"},{"title":"Resume a stalled preview","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/resume/","href":"/api-reference/onboarding-wizard/resume-a-stalled-preview"},{"title":"Pick a segment","deprecated":null,"version":null,"openapi":"/openapi.json put /onboarding-wizard/runs/{run_id}/segment/","href":"/api-reference/onboarding-wizard/pick-a-segment"},{"title":"Add a segment in your own words","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/segments/","href":"/api-reference/onboarding-wizard/add-a-segment-in-your-own-words"},{"title":"Offer three other segments","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding-wizard/runs/{run_id}/segments/regenerate/","href":"/api-reference/onboarding-wizard/offer-three-other-segments"},{"title":"Set who signs the emails","deprecated":null,"version":null,"openapi":"/openapi.json put /onboarding-wizard/runs/{run_id}/sender/","href":"/api-reference/onboarding-wizard/set-who-signs-the-emails"}]},{"group":"onboarding","pages":[{"title":"Get the Getting started checklist","deprecated":null,"version":null,"openapi":"/openapi.json get /onboarding/","href":"/api-reference/onboarding/get-the-getting-started-checklist"},{"title":"Hide the Getting started checklist","deprecated":null,"version":null,"openapi":"/openapi.json patch /onboarding/","href":"/api-reference/onboarding/hide-the-getting-started-checklist"},{"title":"Bring the Getting started checklist up to date","deprecated":null,"version":null,"openapi":"/openapi.json post /onboarding/sync/","href":"/api-reference/onboarding/bring-the-getting-started-checklist-up-to-date"}]},{"group":"outreach","pages":[{"title":"List the approval queue","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/","href":"/api-reference/outreach/list-the-approval-queue"},{"title":"List what went out as a sender","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/activity/","href":"/api-reference/outreach/list-what-went-out-as-a-sender"},{"title":"Count what went out as a sender","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/activity/length/","href":"/api-reference/outreach/count-what-went-out-as-a-sender"},{"title":"Read one activity row","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/activity/{activity_id}/","href":"/api-reference/outreach/read-one-activity-row"},{"title":"Read the email an activity row sent","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/activity/{activity_id}/email/","href":"/api-reference/outreach/read-the-email-an-activity-row-sent"},{"title":"Approve every ticked task","deprecated":null,"version":null,"openapi":"/openapi.json post /outreach-tasks/bulk/approve/","href":"/api-reference/outreach/approve-every-ticked-task"},{"title":"Reject every ticked task","deprecated":null,"version":null,"openapi":"/openapi.json post /outreach-tasks/bulk/reject/","href":"/api-reference/outreach/reject-every-ticked-task"},{"title":"Resolve the approval mode that applies","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/effective-approval/","href":"/api-reference/outreach/resolve-the-approval-mode-that-applies"},{"title":"Stream the workspace's outreach change events","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/events/","href":"/api-reference/outreach/stream-the-workspaces-outreach-change-events"},{"title":"Count the approval queue","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/length/","href":"/api-reference/outreach/count-the-approval-queue"},{"title":"Count what is waiting on a person","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/summary/","href":"/api-reference/outreach/count-what-is-waiting-on-a-person"},{"title":"Read one task","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/{task_id}/","href":"/api-reference/outreach/read-one-task"},{"title":"Rewrite a pending task's message","deprecated":null,"version":null,"openapi":"/openapi.json patch /outreach-tasks/{task_id}/","href":"/api-reference/outreach/rewrite-a-pending-tasks-message"},{"title":"Approve a task","deprecated":null,"version":null,"openapi":"/openapi.json post /outreach-tasks/{task_id}/approve/","href":"/api-reference/outreach/approve-a-task"},{"title":"Mark a Needs human task done","deprecated":null,"version":null,"openapi":"/openapi.json post /outreach-tasks/{task_id}/complete/","href":"/api-reference/outreach/mark-a-needs-human-task-done"},{"title":"Read an email card's email beyond its words","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/{task_id}/email/","href":"/api-reference/outreach/read-an-email-cards-email-beyond-its-words"},{"title":"Reject a task","deprecated":null,"version":null,"openapi":"/openapi.json post /outreach-tasks/{task_id}/reject/","href":"/api-reference/outreach/reject-a-task"},{"title":"Read the rest of an email card's thread","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/{task_id}/thread/","href":"/api-reference/outreach/read-the-rest-of-an-email-cards-thread"},{"title":"Rewrite a follow-up on a pending email card","deprecated":null,"version":null,"openapi":"/openapi.json patch /outreach-tasks/{task_id}/thread/emails/{step_id}/","href":"/api-reference/outreach/rewrite-a-follow-up-on-a-pending-email-card"},{"title":"List the messages the agent writes later for an email card's contact","deprecated":null,"version":null,"openapi":"/openapi.json get /outreach-tasks/{task_id}/thread/later-steps/","href":"/api-reference/outreach/list-the-messages-the-agent-writes-later-for-an-email-cards-contact"}]},{"group":"provider-keys","pages":[{"title":"List provider keys","deprecated":null,"version":null,"openapi":"/openapi.json get /provider-keys/","href":"/api-reference/provider-keys/list-provider-keys"},{"title":"List provider key changes","deprecated":null,"version":null,"openapi":"/openapi.json get /provider-keys/audit-logs/","href":"/api-reference/provider-keys/list-provider-key-changes"},{"title":"List an enrichment's providers","deprecated":null,"version":null,"openapi":"/openapi.json get /provider-keys/enrichments/{action_key}/providers/","href":"/api-reference/provider-keys/list-an-enrichments-providers"},{"title":"Preview a provider order","deprecated":null,"version":null,"openapi":"/openapi.json post /provider-keys/enrichments/{action_key}/providers/preview/","href":"/api-reference/provider-keys/preview-a-provider-order"},{"title":"Read the provider key settings","deprecated":null,"version":null,"openapi":"/openapi.json get /provider-keys/settings/","href":"/api-reference/provider-keys/read-the-provider-key-settings"},{"title":"Set the default provider order","deprecated":null,"version":null,"openapi":"/openapi.json patch /provider-keys/settings/","href":"/api-reference/provider-keys/set-the-default-provider-order"},{"title":"Check stale provider keys","deprecated":null,"version":null,"openapi":"/openapi.json post /provider-keys/verify/","href":"/api-reference/provider-keys/check-stale-provider-keys"},{"title":"Read a provider key","deprecated":null,"version":null,"openapi":"/openapi.json get /provider-keys/{integration_type}/key/","href":"/api-reference/provider-keys/read-a-provider-key"},{"title":"Add or replace a provider key","deprecated":null,"version":null,"openapi":"/openapi.json put /provider-keys/{integration_type}/key/","href":"/api-reference/provider-keys/add-or-replace-a-provider-key"},{"title":"Remove a provider key","deprecated":null,"version":null,"openapi":"/openapi.json delete /provider-keys/{integration_type}/key/","href":"/api-reference/provider-keys/remove-a-provider-key"},{"title":"List the columns using a provider key","deprecated":null,"version":null,"openapi":"/openapi.json get /provider-keys/{integration_type}/key/columns/","href":"/api-reference/provider-keys/list-the-columns-using-a-provider-key"},{"title":"Check a provider key","deprecated":null,"version":null,"openapi":"/openapi.json post /provider-keys/{integration_type}/key/verify/","href":"/api-reference/provider-keys/check-a-provider-key"}]},{"group":"referral","pages":[{"title":"List referrals","deprecated":null,"version":null,"openapi":"/openapi.json get /referrals/","href":"/api-reference/referral/list-referrals"},{"title":"Claim a referral code","deprecated":null,"version":null,"openapi":"/openapi.json post /referrals/claim/","href":"/api-reference/referral/claim-a-referral-code"},{"title":"Count referrals","deprecated":null,"version":null,"openapi":"/openapi.json get /referrals/length/","href":"/api-reference/referral/count-referrals"},{"title":"Get the referral program's reward amounts","deprecated":null,"version":null,"openapi":"/openapi.json get /referrals/program/","href":"/api-reference/referral/get-the-referral-programs-reward-amounts"},{"title":"Get the workspace's referral summary","deprecated":null,"version":null,"openapi":"/openapi.json get /referrals/summary/","href":"/api-reference/referral/get-the-workspaces-referral-summary"}]},{"group":"find-subdomains","pages":[{"title":"Start a subdomain search","deprecated":null,"version":null,"openapi":"/openapi.json post /subdomain-searches/","href":"/api-reference/find-subdomains/start-a-subdomain-search"},{"title":"Get a subdomain search","deprecated":null,"version":null,"openapi":"/openapi.json get /subdomain-searches/{search_id}/","href":"/api-reference/find-subdomains/get-a-subdomain-search"},{"title":"Create a table from a subdomain search","deprecated":null,"version":null,"openapi":"/openapi.json post /subdomain-searches/{search_id}/import/","href":"/api-reference/find-subdomains/create-a-table-from-a-subdomain-search"},{"title":"Get a table's subdomain feed","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/subdomain-feed/","href":"/api-reference/find-subdomains/get-a-tables-subdomain-feed"},{"title":"Check a subdomain table for new subdomains now","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/subdomain-feed/sync/","href":"/api-reference/find-subdomains/check-a-subdomain-table-for-new-subdomains-now"}]},{"group":"table-enrichments","pages":[{"title":"List enrichment actions","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/actions/","href":"/api-reference/table-enrichments/list-enrichment-actions"},{"title":"List agent tools","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/agent-tools/","href":"/api-reference/table-enrichments/list-agent-tools"},{"title":"List built-in agent templates","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/builtin-agent-templates/","href":"/api-reference/table-enrichments/list-built-in-agent-templates"},{"title":"Suggest an enrichment column","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/columns/suggestions/","href":"/api-reference/table-enrichments/suggest-an-enrichment-column"},{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/mcp-servers/","href":"/api-reference/table-enrichments/list-mcp-servers"},{"title":"Create an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/mcp-servers/","href":"/api-reference/table-enrichments/create-an-mcp-server"},{"title":"Start an MCP OAuth connection","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/mcp-servers/authorize/","href":"/api-reference/table-enrichments/start-an-mcp-oauth-connection"},{"title":"Finish an MCP OAuth connection","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/mcp-servers/callback/","href":"/api-reference/table-enrichments/finish-an-mcp-oauth-connection"},{"title":"List the MCP connect catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/mcp-servers/catalog/","href":"/api-reference/table-enrichments/list-the-mcp-connect-catalog"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json delete /table-enrichments/mcp-servers/{mcp_server_id}/","href":"/api-reference/table-enrichments/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json patch /table-enrichments/mcp-servers/{mcp_server_id}/","href":"/api-reference/table-enrichments/update-an-mcp-server"},{"title":"Verify an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/mcp-servers/{mcp_server_id}/verify/","href":"/api-reference/table-enrichments/verify-an-mcp-server"},{"title":"List enrichment models","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/models/","href":"/api-reference/table-enrichments/list-enrichment-models"},{"title":"List saved agents","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/saved-agents/","href":"/api-reference/table-enrichments/list-saved-agents"},{"title":"Create a saved agent","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/","href":"/api-reference/table-enrichments/create-a-saved-agent"},{"title":"Declare the per-row inputs a prompt needs","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/inputs/suggestions/","href":"/api-reference/table-enrichments/declare-the-per-row-inputs-a-prompt-needs"},{"title":"Derive an output schema from a prompt","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/outputs/suggestions/","href":"/api-reference/table-enrichments/derive-an-output-schema-from-a-prompt"},{"title":"Suggest a revised agent prompt from a natural-language change","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/prompt/suggestions/","href":"/api-reference/table-enrichments/suggest-a-revised-agent-prompt-from-a-natural-language-change"},{"title":"Suggest a revised agent prompt from a natural-language change, streaming the work","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/prompt/suggestions/stream/","href":"/api-reference/table-enrichments/suggest-a-revised-agent-prompt-from-a-natural-language-change-streaming-the-work"},{"title":"Stop an agent prompt revision that is being streamed","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/prompt/suggestions/{edit_id}/stop/","href":"/api-reference/table-enrichments/stop-an-agent-prompt-revision-that-is-being-streamed"},{"title":"Suggest an agent from a task, streaming its work","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/suggestions/stream/","href":"/api-reference/table-enrichments/suggest-an-agent-from-a-task-streaming-its-work"},{"title":"Stop an agent suggestion that is being written","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/suggestions/{generation_id}/stop/","href":"/api-reference/table-enrichments/stop-an-agent-suggestion-that-is-being-written"},{"title":"Get a saved agent","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/saved-agents/{saved_agent_id}/","href":"/api-reference/table-enrichments/get-a-saved-agent"},{"title":"Delete a saved agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /table-enrichments/saved-agents/{saved_agent_id}/","href":"/api-reference/table-enrichments/delete-a-saved-agent"},{"title":"Update a saved agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /table-enrichments/saved-agents/{saved_agent_id}/","href":"/api-reference/table-enrichments/update-a-saved-agent"},{"title":"Star a saved agent","deprecated":null,"version":null,"openapi":"/openapi.json put /table-enrichments/saved-agents/{saved_agent_id}/favorite/","href":"/api-reference/table-enrichments/star-a-saved-agent"},{"title":"Unstar a saved agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /table-enrichments/saved-agents/{saved_agent_id}/favorite/","href":"/api-reference/table-enrichments/unstar-a-saved-agent"},{"title":"List an agent's attached MCP servers","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/saved-agents/{saved_agent_id}/mcp-servers/","href":"/api-reference/table-enrichments/list-an-agents-attached-mcp-servers"},{"title":"Set an agent's attached MCP servers","deprecated":null,"version":null,"openapi":"/openapi.json put /table-enrichments/saved-agents/{saved_agent_id}/mcp-servers/","href":"/api-reference/table-enrichments/set-an-agents-attached-mcp-servers"},{"title":"Record that the caller opened this agent","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/{saved_agent_id}/open/","href":"/api-reference/table-enrichments/record-that-the-caller-opened-this-agent"},{"title":"Remember a saved agent's example rows","deprecated":null,"version":null,"openapi":"/openapi.json put /table-enrichments/saved-agents/{saved_agent_id}/sample-rows/","href":"/api-reference/table-enrichments/remember-a-saved-agents-example-rows"},{"title":"Where a saved agent is used","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/saved-agents/{saved_agent_id}/usage/","href":"/api-reference/table-enrichments/where-a-saved-agent-is-used"},{"title":"List a saved agent's versions","deprecated":null,"version":null,"openapi":"/openapi.json get /table-enrichments/saved-agents/{saved_agent_id}/versions/","href":"/api-reference/table-enrichments/list-a-saved-agents-versions"},{"title":"Revert a saved agent to a version","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/{saved_agent_id}/versions/{version}/revert/","href":"/api-reference/table-enrichments/revert-a-saved-agent-to-a-version"}]},{"group":"table-columns","pages":[{"title":"Add a saved agent to a table","deprecated":null,"version":null,"openapi":"/openapi.json post /table-enrichments/saved-agents/{saved_agent_id}/apply/","href":"/api-reference/table-columns/add-a-saved-agent-to-a-table"},{"title":"List the formula functions","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/formula-functions/","href":"/api-reference/table-columns/list-the-formula-functions"},{"title":"List table columns","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/","href":"/api-reference/table-columns/list-table-columns"},{"title":"Create a table column","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/","href":"/api-reference/table-columns/create-a-table-column"},{"title":"Delete several columns","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/columns/","href":"/api-reference/table-columns/delete-several-columns"},{"title":"Suggest input→column mappings for an agent","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/agent-input-mapping/suggestions/","href":"/api-reference/table-columns/suggest-input→column-mappings-for-an-agent"},{"title":"Get what each paid column costs per row","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/credit-rates/","href":"/api-reference/table-columns/get-what-each-paid-column-costs-per-row"},{"title":"List column groups","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/groups/","href":"/api-reference/table-columns/list-column-groups"},{"title":"Group columns","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/groups/","href":"/api-reference/table-columns/group-columns"},{"title":"Ungroup","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/columns/groups/{group_id}/","href":"/api-reference/table-columns/ungroup"},{"title":"Update a column group","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/columns/groups/{group_id}/","href":"/api-reference/table-columns/update-a-column-group"},{"title":"Suggest a name for a new column","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/name/suggestions/","href":"/api-reference/table-columns/suggest-a-name-for-a-new-column"},{"title":"Preview a column definition","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/preview/","href":"/api-reference/table-columns/preview-a-column-definition"},{"title":"Reorder table columns","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/reorder/","href":"/api-reference/table-columns/reorder-table-columns"},{"title":"Generate a formula column from a description","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/suggestions/","href":"/api-reference/table-columns/generate-a-formula-column-from-a-description"},{"title":"Delete a table column","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/columns/{column_id}/","href":"/api-reference/table-columns/delete-a-table-column"},{"title":"Update a table column","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/columns/{column_id}/","href":"/api-reference/table-columns/update-a-table-column"},{"title":"Get a table column's value distribution","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/{column_id}/distribution/","href":"/api-reference/table-columns/get-a-table-columns-value-distribution"},{"title":"List the rows pointing at one row","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/{column_id}/pointing-rows/","href":"/api-reference/table-columns/list-the-rows-pointing-at-one-row"},{"title":"Preview a column type change","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/{column_id}/preview/","href":"/api-reference/table-columns/preview-a-column-type-change"},{"title":"Promote an enrichment output field into its own column","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/{column_id}/promote/","href":"/api-reference/table-columns/promote-an-enrichment-output-field-into-its-own-column"},{"title":"Keep a linked value's column as a plain column","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/columns/{column_id}/release/","href":"/api-reference/table-columns/keep-a-linked-values-column-as-a-plain-column"},{"title":"List the links of other tables into this one","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/link-readers/","href":"/api-reference/table-columns/list-the-links-of-other-tables-into-this-one"},{"title":"List what a link to another table can bring back","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/reference-fields/","href":"/api-reference/table-columns/list-what-a-link-to-another-table-can-bring-back"},{"title":"Preview how a link to another table would match","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/references/preview/","href":"/api-reference/table-columns/preview-how-a-link-to-another-table-would-match"}]},{"group":"table-imports","pages":[{"title":"Upload a CSV or Excel file as a pending import","deprecated":null,"version":null,"openapi":"/openapi.json post /table-imports/","href":"/api-reference/table-imports/upload-a-csv-or-excel-file-as-a-pending-import"},{"title":"Get a CSV import's status","deprecated":null,"version":null,"openapi":"/openapi.json get /table-imports/{import_id}/","href":"/api-reference/table-imports/get-a-csv-imports-status"},{"title":"Re-read a pending upload from a different sheet","deprecated":null,"version":null,"openapi":"/openapi.json patch /table-imports/{import_id}/","href":"/api-reference/table-imports/re-read-a-pending-upload-from-a-different-sheet"},{"title":"Read an import column's value distribution","deprecated":null,"version":null,"openapi":"/openapi.json get /table-imports/{import_id}/columns/{source_index}/distribution/","href":"/api-reference/table-imports/read-an-import-columns-value-distribution"},{"title":"List an import column's raw values","deprecated":null,"version":null,"openapi":"/openapi.json get /table-imports/{import_id}/columns/{source_index}/values/","href":"/api-reference/table-imports/list-an-import-columns-raw-values"},{"title":"Create the table and start loading its rows","deprecated":null,"version":null,"openapi":"/openapi.json post /table-imports/{import_id}/commit/","href":"/api-reference/table-imports/create-the-table-and-start-loading-its-rows"}]},{"group":"table-writeback","pages":[{"title":"Derive what one destination record type can do","deprecated":null,"version":null,"openapi":"/openapi.json get /table-writeback/capabilities/","href":"/api-reference/table-writeback/derive-what-one-destination-record-type-can-do"},{"title":"Dry-run an export against real rows","deprecated":null,"version":null,"openapi":"/openapi.json post /table-writeback/preview/","href":"/api-reference/table-writeback/dry-run-an-export-against-real-rows"},{"title":"Summarise what an export column has pushed","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/columns/{column_id}/push-summary/","href":"/api-reference/table-writeback/summarise-what-an-export-column-has-pushed"}]},{"group":"tables","pages":[{"title":"List tables","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/","href":"/api-reference/tables/list-tables"},{"title":"Create a table","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/","href":"/api-reference/tables/create-a-table"},{"title":"Change several tables at once","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/bulk/","href":"/api-reference/tables/change-several-tables-at-once"},{"title":"List folders","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/folders/","href":"/api-reference/tables/list-folders"},{"title":"Make a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/folders/","href":"/api-reference/tables/make-a-folder"},{"title":"Suggest folders for the tables in no folder","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/folders/suggestions/","href":"/api-reference/tables/suggest-folders-for-the-tables-in-no-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/folders/{folder_id}/","href":"/api-reference/tables/delete-a-folder"},{"title":"Rename, move or re-own a folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/folders/{folder_id}/","href":"/api-reference/tables/rename-move-or-re-own-a-folder"},{"title":"Restore a folder from Trash","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/folders/{folder_id}/restore/","href":"/api-reference/tables/restore-a-folder-from-trash"},{"title":"Get the number of tables","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/length/","href":"/api-reference/tables/get-the-number-of-tables"},{"title":"List who owns tables","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/owners/","href":"/api-reference/tables/list-who-owns-tables"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/","href":"/api-reference/tables/get-table-details"},{"title":"Delete a table","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/","href":"/api-reference/tables/delete-a-table"},{"title":"Update a table","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/","href":"/api-reference/tables/update-a-table"},{"title":"Suggest a description for a table","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/description/suggestions/","href":"/api-reference/tables/suggest-a-description-for-a-table"},{"title":"Duplicate a table","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/duplicate/","href":"/api-reference/tables/duplicate-a-table"},{"title":"Restore a trashed table","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/restore/","href":"/api-reference/tables/restore-a-trashed-table"},{"title":"Get table stats","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/stats/","href":"/api-reference/tables/get-table-stats"},{"title":"Get table change status","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/status/","href":"/api-reference/tables/get-table-change-status"},{"title":"Read a table published as a template","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/template/","href":"/api-reference/tables/read-a-table-published-as-a-template"}]},{"group":"table-column-color-labels","pages":[{"title":"Get column colour names","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/color-labels/","href":"/api-reference/table-column-color-labels/get-column-colour-names"},{"title":"Rename column colours","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/color-labels/","href":"/api-reference/table-column-color-labels/rename-column-colours"}]},{"group":"table-sources","pages":[{"title":"Sample records before importing them","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/preview/","href":"/api-reference/table-sources/sample-records-before-importing-them"},{"title":"Get a table's import source","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/source/","href":"/api-reference/table-sources/get-a-tables-import-source"},{"title":"Detach a table's import source","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/source/","href":"/api-reference/table-sources/detach-a-tables-import-source"},{"title":"Update a table's import source","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/source/","href":"/api-reference/table-sources/update-a-tables-import-source"},{"title":"List the fields a table's imported rows could be matched on","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/source/identity-options/","href":"/api-reference/table-sources/list-the-fields-a-tables-imported-rows-could-be-matched-on"},{"title":"Give one field of the imported record its own column","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/source/promote/","href":"/api-reference/table-sources/give-one-field-of-the-imported-record-its-own-column"},{"title":"List a table's recent imports","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/source/runs/","href":"/api-reference/table-sources/list-a-tables-recent-imports"},{"title":"Refresh a table from its source now","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/source/runs/","href":"/api-reference/table-sources/refresh-a-table-from-its-source-now"},{"title":"Get an import run's status","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/source/runs/{run_id}/","href":"/api-reference/table-sources/get-an-import-runs-status"},{"title":"List the records an import run skipped","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/source/runs/{run_id}/skips/","href":"/api-reference/table-sources/list-the-records-an-import-run-skipped"}]},{"group":"table-webhooks","pages":[{"title":"List what can send records to a table by webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/webhook-sources/","href":"/api-reference/table-webhooks/list-what-can-send-records-to-a-table-by-webhook"},{"title":"Get a table's live changes","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/live-changes/","href":"/api-reference/table-webhooks/get-a-tables-live-changes"},{"title":"Turn on a table's live changes","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/live-changes/","href":"/api-reference/table-webhooks/turn-on-a-tables-live-changes"},{"title":"Turn off a table's live changes","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/live-changes/","href":"/api-reference/table-webhooks/turn-off-a-tables-live-changes"},{"title":"List a table's webhook URLs","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/webhook-endpoints/","href":"/api-reference/table-webhooks/list-a-tables-webhook-urls"},{"title":"Give a table a webhook URL","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/webhook-endpoints/","href":"/api-reference/table-webhooks/give-a-table-a-webhook-url"},{"title":"Get a table's webhook URL","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/webhook-endpoints/{endpoint_id}/","href":"/api-reference/table-webhooks/get-a-tables-webhook-url"},{"title":"Revoke a webhook URL","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/webhook-endpoints/{endpoint_id}/","href":"/api-reference/table-webhooks/revoke-a-webhook-url"},{"title":"Make a new webhook URL in place of a revoked one","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/webhook-endpoints/{endpoint_id}/duplicate/","href":"/api-reference/table-webhooks/make-a-new-webhook-url-in-place-of-a-revoked-one"},{"title":"List a webhook URL's failed deliveries","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/webhook-endpoints/{endpoint_id}/failures/","href":"/api-reference/table-webhooks/list-a-webhook-urls-failed-deliveries"},{"title":"Retry a failed delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/webhook-endpoints/{endpoint_id}/failures/{failure_id}/retry/","href":"/api-reference/table-webhooks/retry-a-failed-delivery"},{"title":"Replace a webhook URL's key","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/webhook-endpoints/{endpoint_id}/regenerate-token/","href":"/api-reference/table-webhooks/replace-a-webhook-urls-key"},{"title":"Show a webhook URL in full","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/webhook-endpoints/{endpoint_id}/reveal/","href":"/api-reference/table-webhooks/show-a-webhook-url-in-full"},{"title":"List a webhook URL's secrets","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/webhook-endpoints/{endpoint_id}/secrets/","href":"/api-reference/table-webhooks/list-a-webhook-urls-secrets"},{"title":"Save a webhook URL's secret","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/webhook-endpoints/{endpoint_id}/secrets/{kind}/","href":"/api-reference/table-webhooks/save-a-webhook-urls-secret"},{"title":"Clear a webhook URL's secret","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/webhook-endpoints/{endpoint_id}/secrets/{kind}/","href":"/api-reference/table-webhooks/clear-a-webhook-urls-secret"},{"title":"Get whether a table's webhook rows are landing","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/webhook-feed/","href":"/api-reference/table-webhooks/get-whether-a-tables-webhook-rows-are-landing"},{"title":"Resume a table's paused webhook rows","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/webhook-feed/resume/","href":"/api-reference/table-webhooks/resume-a-tables-paused-webhook-rows"}]},{"group":"table-rows","pages":[{"title":"Rate many cells at once","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/cell-feedback/bulk/","href":"/api-reference/table-rows/rate-many-cells-at-once"},{"title":"Create table rows","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/","href":"/api-reference/table-rows/create-table-rows"},{"title":"Set many table cell values","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/rows/bulk/","href":"/api-reference/table-rows/set-many-table-cell-values"},{"title":"Bulk delete table rows","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/bulk/delete/","href":"/api-reference/table-rows/bulk-delete-table-rows"},{"title":"Query a listing's row IDs","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/ids/","href":"/api-reference/table-rows/query-a-listings-row-ids"},{"title":"Count the rows a filter selects","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/length/","href":"/api-reference/table-rows/count-the-rows-a-filter-selects"},{"title":"Query table rows","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/query/","href":"/api-reference/table-rows/query-table-rows"},{"title":"Search a table's cells","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/search/","href":"/api-reference/table-rows/search-a-tables-cells"},{"title":"Count a search's matches","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/search/length/","href":"/api-reference/table-rows/count-a-searchs-matches"},{"title":"Set a table cell value","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/rows/{record_id}/","href":"/api-reference/table-rows/set-a-table-cell-value"},{"title":"Get your feedback on a cell","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/rows/{record_id}/cells/{column_id}/feedback/","href":"/api-reference/table-rows/get-your-feedback-on-a-cell"},{"title":"Rate a cell's value","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/rows/{record_id}/cells/{column_id}/feedback/","href":"/api-reference/table-rows/rate-a-cells-value"},{"title":"Withdraw your feedback on a cell","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/rows/{record_id}/cells/{column_id}/feedback/","href":"/api-reference/table-rows/withdraw-your-feedback-on-a-cell"},{"title":"Get a cell's enrichment run detail","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/rows/{record_id}/cells/{column_id}/run-detail/","href":"/api-reference/table-rows/get-a-cells-enrichment-run-detail"}]},{"group":"table-ui-prefs","pages":[{"title":"Update a column's display preferences","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/columns/{column_id}/ui-prefs/","href":"/api-reference/table-ui-prefs/update-a-columns-display-preferences"}]},{"group":"table-enrichment-audit-logs","pages":[{"title":"List a table's enrichment audit trail","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/enrichment-audit-logs/","href":"/api-reference/table-enrichment-audit-logs/list-a-tables-enrichment-audit-trail"}]},{"group":"table-events","pages":[{"title":"Stream a table's change events","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/events/","href":"/api-reference/table-events/stream-a-tables-change-events"}]},{"group":"table-user-prefs","pages":[{"title":"Star a table","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/favorite/","href":"/api-reference/table-user-prefs/star-a-table"},{"title":"Unstar a table","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/favorite/","href":"/api-reference/table-user-prefs/unstar-a-table"},{"title":"Read the view the caller last left this table on","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/last-view/","href":"/api-reference/table-user-prefs/read-the-view-the-caller-last-left-this-table-on"},{"title":"Remember the view the caller is leaving this table on","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/last-view/","href":"/api-reference/table-user-prefs/remember-the-view-the-caller-is-leaving-this-table-on"},{"title":"Record that the caller opened this table","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/open/","href":"/api-reference/table-user-prefs/record-that-the-caller-opened-this-table"}]},{"group":"table-export","pages":[{"title":"Export table rows as a CSV or Excel file","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/rows/export/","href":"/api-reference/table-export/export-table-rows-as-a-csv-or-excel-file"}]},{"group":"table-runs","pages":[{"title":"List table runs","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/runs/","href":"/api-reference/table-runs/list-table-runs"},{"title":"Start a table run","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/runs/","href":"/api-reference/table-runs/start-a-table-run"},{"title":"Stop all table runs","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/runs/bulk/cancel/","href":"/api-reference/table-runs/stop-all-table-runs"},{"title":"Preview a table run","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/runs/preview/","href":"/api-reference/table-runs/preview-a-table-run"},{"title":"Cancel a table run","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/runs/{run_id}/cancel/","href":"/api-reference/table-runs/cancel-a-table-run"}]},{"group":"table-schedules","pages":[{"title":"Get a table's refresh cadence","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/schedule/","href":"/api-reference/table-schedules/get-a-tables-refresh-cadence"},{"title":"Set a table's refresh cadence","deprecated":null,"version":null,"openapi":"/openapi.json put /tables/{table_id}/schedule/","href":"/api-reference/table-schedules/set-a-tables-refresh-cadence"},{"title":"Stop a table refreshing on a cadence","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/schedule/","href":"/api-reference/table-schedules/stop-a-table-refreshing-on-a-cadence"},{"title":"Change a table's refresh cadence","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/schedule/","href":"/api-reference/table-schedules/change-a-tables-refresh-cadence"}]},{"group":"table-views","pages":[{"title":"List table views","deprecated":null,"version":null,"openapi":"/openapi.json get /tables/{table_id}/views/","href":"/api-reference/table-views/list-table-views"},{"title":"Create a table view","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/views/","href":"/api-reference/table-views/create-a-table-view"},{"title":"Delete a table view","deprecated":null,"version":null,"openapi":"/openapi.json delete /tables/{table_id}/views/{view_id}/","href":"/api-reference/table-views/delete-a-table-view"},{"title":"Update a table view","deprecated":null,"version":null,"openapi":"/openapi.json patch /tables/{table_id}/views/{view_id}/","href":"/api-reference/table-views/update-a-table-view"},{"title":"Count what a new filter does to the sequences that follow a view","deprecated":null,"version":null,"openapi":"/openapi.json post /tables/{table_id}/views/{view_id}/impact/","href":"/api-reference/table-views/count-what-a-new-filter-does-to-the-sequences-that-follow-a-view"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Move one contact to another sequence - Oneprofile","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}