Skip to content
Reachiz
API
Select theme
Dark
Light
Auto
/
Overview
Reachiz API
Overview
Accounts
Overview
Get a LinkedIn account
List LinkedIn accounts
Approvals
Overview
Approve a waiting message or email: it sends as written
Edit the text of a waiting message or email. It stays waiting unless approve is true
Messages and emails that wait for approval, oldest first. Filter by campaignId
Skip a waiting message or email: the person moves on to the next step
Autopilot
Overview
Accept the sample leads and the copy
Add a customer type from free text
Add a writing rule to the style doc, then rewrite the first sequence
Ask the agent to change the play (steps or targets). Runs in the background: poll the play until working is null
Check whether the snippet has sent its first visit
Connect PostHog with a read-only personal API key. The key is checked, then stored sealed and never returned
Connect Stripe with a read-only restricted key (rk_...). Imports the customers of canceled subscriptions as leads in a Former customers list
Design 3 ranked plays from the confirmed targets. Runs in the background: poll GET /v1/autopilot
Disconnect a source (site, posthog or stripe) and delete its stored key
Get Autopilot: setup answers, progress, plays, senders and alert settings
Get one play: strategy, sample leads with their rendered messages, steps and the conversation log
Launch a play in review: create its campaign and start it now, or at the next 8:00
List the plays, best rank first, with status and sequence
List the saved sequence templates of Autopilot plays
Mark one sample lead as a good fit or not a fit
Pause Autopilot and its running campaigns
Read a website, or a description when there is none, into a business profile and 5 customer types. Runs in the background: poll GET /v1/autopilot
Read the ideal-customer doc (icp) or the writing-style doc (style)
Register a website for the visitor snippet. The answer carries the key and the script tag to paste
Replace the steps of a play (before it runs). Comment and manual steps are refused for now
Replace the steps of a play with a saved template
Resume Autopilot
Save a doc as a new version
Save setup answers: step, customerTypeId (starts the targets), targets, channel, country, offer, timezone
Save the steps of a play as a template
Set where Autopilot reaches you: an email address or a Slack webhook URL
Stop a play and its campaign
The connected sources: website snippet, PostHog, Stripe (former customers)
Turn Autopilot on. Needs a trial or paid plan and a connected LinkedIn account. Plays build now and start at 8:00 the next morning
Write the first play's sequence in the writing style: an invite, then LinkedIn messages on days 2, 5 and 9. Runs in the background
Billing
Overview
Add 7 days to the trial before the first charge. Once per account, only while trialing
Cancel at the end of the period (a trial ends at its trial end, with no charge). Needs 20 characters of feedback or the text Confirm cancellation
When the plan ends, and whether the trial can still get its extra week
Campaigns
Overview
Add existing leads to a campaign
Change campaign settings. Turning approval off releases every message that waits
Create a draft campaign
Get a campaign
Get the settings of a campaign: approval, sender names, out of office, daily cap, priority, auto pause, skips
List campaigns
List the leads of a campaign with their state
Pause a running campaign
Resume a paused campaign
Start a draft campaign
Conversations
Overview
Get a conversation with its messages
List conversations
Send a message in a conversation
Leads
Overview
Get a lead
Update the custom fields and tags of a lead
Lists
Overview
Add up to 1000 profiles to a list
Create a lead list
Delete a lead list and its leads
Find emails or phones for leads in a list that do not have them yet (a miss is free)
Find leads by title, location, industry and company size (3 credits per lead added)
Get a find-leads search and how many leads it added
Get a lead list
List lead lists
List the leads of a list
Rename a lead list
Set a list's filters (replaces them), which score each lead's fit in the table
Signals
Overview
Look up one buying signal: hiring, funding, tech stack, news, headcount or a job change. Charges credits only on a hit
Status
Overview
Check that the API is up
OpenAPI 3.1 description of this API
Webhooks
Overview
Create a webhook. The response holds the signing secret once.
Delete a webhook
List webhooks
Select theme
Dark
Light
Auto
API Reference
Reachiz API
Status
Check that the API is up
View as Markdown
Check that the API is up
GET
/v1/status
Returns
Section titled “Returns”
status
string
version
string
time
string
