Hlix Growth API
Growth projects: the Company brain, campaigns, research runs and data-provider keys.
Operations 65
GET
/v1/api/growth/chains
Each capability's data-provider order and how each provider did in the last 7…
#
POST
/v1/api/growth/chains/find_email/compare
Run two email finders on the same sample of the workspace's leads
#
PUT
/v1/api/growth/chains/{capability}
Set the order a capability tries its providers in, or go back to the default
#
GET
/v1/api/growth/enrich
Hlix Enrich price: what one email sent to a lead built on Hlix's data costs
#
POST
/v1/api/growth/leads/{leadId}/refine-reply
Refine a reply against the lead thread and sourced project context without…
#
POST
/v1/api/growth/leads/{leadId}/reply
Answer a lead in their thread from the mailbox that wrote to them
#
GET
/v1/api/growth/mailboxes
List the workspace's sending mailboxes with their warm-up and today's sends
#
PATCH
/v1/api/growth/mailboxes/{mailboxId}
Change a mailbox's daily limit or warm-up start, or pause and resume it
#
GET
/v1/api/growth/mailboxes/{mailboxId}/dns
Check the mailbox domain's SPF, DKIM and DMARC records
#
GET
/v1/api/growth/managed-mailboxes/configuration
Read managed mailbox configuration and commercial readiness
#
POST
/v1/api/growth/managed-mailboxes/import
Connect existing InboxKit domains and mailboxes without purchasing them again
#
POST
/v1/api/growth/managed-mailboxes/orders
Persist a managed mailbox order before provider dispatch
#
POST
/v1/api/growth/managed-mailboxes/orders/{orderId}/reconcile
Reconcile provider evidence without replaying uncertain purchases
#
POST
/v1/api/growth/managed-mailboxes/quotes
Observe domain availability and recurring mailbox prices
#
POST
/v1/api/growth/managed-mailboxes/resources/{resourceId}/cancel-hosting
Block new cold sends immediately and request hosting cancellation
#
POST
/v1/api/growth/managed-mailboxes/resources/{resourceId}/cancel-warmup
Cancel warmup separately from mailbox hosting
#
POST
/v1/api/growth/managed-mailboxes/resources/{resourceId}/remove-domain
Request domain removal without claiming a refund or renewal cancellation
#
POST
/v1/api/growth/managed-mailboxes/resources/{resourceId}/repair
Repair a failed resource step without repurchasing successful resources
#
POST
/v1/api/growth/messages/{messageId}/approve
Approve a drafted email, optionally edited, so it sends
#
POST
/v1/api/growth/messages/{messageId}/resolve
Record whether an email whose delivery was unknown went out
#
POST
/v1/api/growth/plays/{playId}/research
Find or resume leads for one campaign without repeating completed research
#
GET
/v1/api/growth/projects/{projectId}/batches
Research lists and their twelve-hour review deadlines
#
POST
/v1/api/growth/projects/{projectId}/batches/{batchId}/approve
Release a researched lead list before its review deadline
#
PUT
/v1/api/growth/projects/{projectId}/daily-budget
Set or remove what all of a growth project's campaigns may spend per day
#
POST
/v1/api/growth/projects/{projectId}/index-leads
Add people and companies from Hlix's shared index to a growth project
#
GET
/v1/api/growth/projects/{projectId}/lead-exports/{exportId}
Download a project's lead CSV export
#
POST
/v1/api/growth/projects/{projectId}/lead-lists/from-tool-call
Import the people a completed tool call returned
#
GET
/v1/api/growth/projects/{projectId}/leads
List a growth project's leads with their evidence and provenance
#
POST
/v1/api/growth/projects/{projectId}/leads/export/preview
What exporting the matching leads would cost, before exporting
#
GET
/v1/api/growth/projects/{projectId}/overview
A growth project's outreach, hot leads and spend per day, with its daily budget
#
GET
/v1/api/growth/projects/{projectId}/sending-schedule
Resolve project and campaign sending schedules
#
PATCH
/v1/api/growth/projects/{projectId}/sending-schedule
Set or inherit a project's sending schedule
#
GET
/v1/api/growth/projects/{projectId}/spend
Show each campaign's data-provider spend for today and the last 30 days
#
PATCH
/v1/api/growth/providers/{provider}
Turn a growth provider on or off for the workspace, or change its settings
#
DELETE
/v1/api/growth/providers/{provider}/key
Remove the workspace's own key for a growth provider
#
PUT
/v1/api/growth/providers/{provider}/key
Add or replace the workspace's own key for a growth provider
#
DELETE
/v1/api/growth/suppressions/{suppressionId}
Remove an entry a person added to the do-not-contact list
#