Models

SenderEmailIDs are the sender emails to attach. Every ID must be a connected sender email in your workspace; the call is refused whole if any is not.

AlreadyAttached lists the requested sender emails that were attached before this call (the call is idempotent: they are left untouched).

Attached lists the sender emails newly attached by this call.

SenderEmailIDs lists every sender email attached to the campaign after this call.

BudgetUsd is the total monthly budget in dollars, inclusive of the platform subscription. Required, must be greater than zero.

MaxMailboxes caps infrastructure regardless of budget. 0 means no cap.

PlatformUsd is the subscription cost to reserve before sizing infrastructure. Defaults to 0.

ExpectedMeetingsPerMonth is a planning ESTIMATE on pessimistic funnel assumptions, not a promise.

Feasible reports whether the budget covers a usable setup at all.

FirstMonthUsd includes the one-off setup on top of the recurring cost.

Notes explains anything worth surfacing to a human.

RecurringUsd is the steady-state monthly cost.

SetupUsd is the one-off cost in the first month (mailbox setup fees and annual domain registrations).

ApprovedAt is when a human approved the run (RFC3339), or null.

ApprovedByUserID is who approved the run, or null.

KillSwitch reports whether the run has been permanently halted.

LastAdvancedAt is when the run last made progress (RFC3339), or null.

Status is one of: pending, building_icp, writing_sequence, sourcing_prospects, awaiting_approval, provisioning_infrastructure, running, paused, completed, failed. A run is at sourcing_prospects twice: before approval it checks for free that prospects match, after approval (approvedAt set) it reveals the first batch, which spends credits.

Country is an ISO 3166-1 alpha-2 code, uppercase.

PhoneCc is the telephone country calling code without the plus.

PostalAddress is the address rendered on one line, ready to paste into a compliance footer. Read-only; it is derived from the fields above.

UpdatedAt is when the profile was last written (RFC3339).

DelistURL is where to request removal. Always present: a listing you cannot act on is trivia.

Scope is "workspace" (default) or "global". A global entry suppresses across every workspace on the account and can only be written with a main workspace's API key.

Values holds the email addresses and/or domains to block, up to 1000 per request.

Created is the number of new suppression entries written.

Scope is the list the entries were written to.

Skipped is the number of values ignored because they already existed or failed validation.

Ids are entry ids as returned by GET /blocklist.

Scope limits the delete to one list: "workspace" (default), "global", or "all". Deleting from "global" requires a main workspace's key.

Values are domains or email addresses to unblock, matched case-insensitively. Values not present are counted as skipped.

Deleted is the number of entries removed.

Skipped is the number of requested values or ids that matched nothing the caller may delete.

EmailAddress is the blocked address when the entry blocks one address rather than a whole domain.

Scope is "workspace" for the calling workspace's own entry, "global" for an account-wide one.

WorkspaceId is the workspace the entry is stored on. For a global entry read from a sub-workspace this is the main workspace, not the caller.

Scope moves the entry between the workspace list and the account-wide list. Moving an entry to "global" requires a main workspace's key.

Value is the new domain or email address. Which of the two the entry holds is re-inferred from whether the value contains "@", so an entry can be converted between a domain block and an address block.

Health score 0-100, higher is better: the share of this account's warm-up emails over the last 7 full days that landed in the inbox rather than spam. Null while warm-up is off or before 20 warm-up emails were checked.

HeldBack is true when the campaign's minimum holds this account back: it sends nothing in this campaign until its score is back at or above the minimum.

Reason says why it is held back, in plain words. Null when it sends.

Accounts are the campaign's connected email accounts, the held-back ones first.

AllHeldBack is true when a minimum is set and every connected account is below it, so the campaign sends nothing.

HeldBackCount is how many of those accounts the minimum holds back.

Message says what the minimum is doing, in plain words. Null when it holds nothing back.

MinimumHealthScore is the campaign's minimum, 1-100. Null when it has none.

DaysSchedule is the sending days as one comma-separated string of weekday numbers, where Sunday is 0: "1,2,3,4,5" is Monday to Friday. It is not an array. Empty until days are set with PUT /campaigns/{id}/schedule.

DailyLimit is the campaign-level cap on total emails scheduled per calendar day (campaign timezone). null means no campaign-level cap.

MinimumHealthScore is the lowest email account health score that may send in this campaign, 1-100. null means no minimum.

Reason says why the domain cannot be bought, in words that can be shown to a person. Empty when available is true.

Unconfirmed is true when we could not get an answer at all rather than the answer "no". Do not report these as taken; offer a retry.

ImapServerUrl and SmtpServerUrl accept the provider's host, optionally with a port, for example "imap.fastmail.com:993".

LoginString defaults to the email address when omitted, which is what most providers expect.

Direction is "inbound" (received from the prospect) or "outbound" (sent, scheduled, or drafted by the workspace).

IsDraft marks unsent drafts (status draft or followup_draft), including AI-suggested replies awaiting human review. An AI reply draft (campaignId null) can be edited with PUT /reply-drafts/{id} and sent with POST /reply-drafts/{id}/send, using this id. Drafts that belong to a campaign cannot be sent this way.

ResponseCategory is set on categorized inbound emails and null everywhere else.

SentAt is the scheduled or actual send time and null when the email has none (e.g. an AI draft that was never scheduled).

ICP is optional and carried through for reference only.

Name is the campaign name.

SalesNavData is the optional base64 browser-extension payload that carries the LinkedIn session required to actually run the search. When omitted the lead engine cannot authenticate to LinkedIn (see docs), so provide it to start real extraction. It needs SalesNavSearchURL.

SalesNavSearchURL is the optional LinkedIn Sales Navigator search URL the lead engine should extract leads from. Leave it out to create the draft with its emails only and add leads from Lead Finder or a CSV upload. It is required when SalesNavData is given.

Sequence is the cold-email sequence to seed the draft campaign with.

Context is optional extra guidance from the caller (e.g. "we sell to dentists in the US").

Description is what the company sells and to whom, in its own words. When given, the plan is built from it and the website is not read: send it when the website shows a placeholder page (the 422 answer).

Website is the company homepage to analyse (with or without scheme).

FollowUpAfter is the number of days after the previous step. 0 for the initial email; 1-30 for follow-ups.

DailyLimit caps the total emails (initial + follow-ups) this campaign may schedule per calendar day in the campaign timezone. Omit for no campaign-level cap; per-inbox limits still apply either way.

Flow defaults to multiple_leads_scheduled, which is what the app creates, so a campaign made through the API behaves identically to one made in the UI. The api flow skips lead validation and the processing-leads guard at launch; pass it only if you want that.

Settings - all optional, mirroring UpdateCampaignRequest

MinimumHealthScore, 1-100, is the lowest email account health score (see healthScore on the sender emails) that may send in this campaign. An account below it, or with no score yet, sends nothing here, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. Omit or send 0 for no minimum.

ExpiresAt is set when the key expires: it inherits the calling key's own expiry, so a temporary key never mints a permanent one. Null for keys minted by a non-expiring key.

ForwardingDomain is where the purchased domains redirect visitors.

Emails are the addresses to verify. Duplicates are removed before anything is charged, and syntactically invalid entries are returned in invalid_emails rather than billed.

Name is what the job is called in the app. Required.

DuplicateRows is how many repeats were removed. Each one would have been a second paid check for an answer already bought.

EstimateHighUsd assumes every address runs both providers. This is the common case and the number to plan against.

EstimateLowUsd assumes every address settles on the first provider.

ID of the created job.

InvalidEmails are the submitted entries that are not addresses at all. They were not charged for and are not in the job.

Total is how many addresses were accepted, after removing duplicates and unparseable entries.

MakePrimary promotes this profile to the workspace's active one, demoting any existing primary.

Summary is one to three sentences describing who the workspace sells to.

Name shown in the app's API key list. Defaults to "<workspace name> key". Trimmed; up to 60 characters.

ReadOnly mints a key that can call GET routes and four POSTs that buy and send nothing (/r/audience/size, /r/setup/ping, /r/dfy/domains/check and /r/lead-finder/searches), and nothing else. Defaults to false, which mints a read+write key.

Note reminds integrators that fullKey is not retrievable later.

GenerateApiKey mints a read+write API key bound to the new workspace. Defaults to true; pass false to create the workspace only.

Name of the new workspace. Trimmed; 1-60 characters.

ApiKey is null when generateApiKey was false.

Note reminds integrators that fullKey is not retrievable later.

Unlimited is true when this workspace's credits are free: every credit action goes through without spending available, nothing is refused for lack of credits, and POST /credits/purchase is refused (code credits_free) because there is nothing to buy.

Amount is the signed credit delta: negative for spend, positive for grants and refunds.

BalanceAfter is the available balance immediately after this entry.

Free is true for an entry written while this workspace's credits were free. Its amount is what the action would have cost, no credits moved, and balanceAfter is the balance it found.

Kind is the movement type: grant, topup, reserve, commit, refund, expire or adjustment.

Reason is what the credits were spent on or granted for.

Reference correlates the entry to what caused it, e.g. 'prospect_search:123'.

Detached is false when the sender email was not attached to the campaign (the call is idempotent and does nothing in that case).

SenderEmailIDs lists every sender email still attached to the campaign after this call.

CompletedAt is when the order completed (RFC3339), or null.

ProcessedAt is when the order started processing (RFC3339), or null.

Status is one of: created, pending_approval, processing, completed, failed, partially_completed, canceled.

CheckedSelectors is every selector name looked up, in the order tried.

Selector is the DKIM selector the record was found under, null when no record was found.

SelectorSource says where selector came from: SIGNATURE (read off the DKIM-Signature of this domain's warm-up mail), CUSTOMER (set in the app) or COMMON (a provider's default name). Null when none was found.

Status is one of OK, WARNING, MISSING, ERROR. MISSING means no key was found under the selectors in checkedSelectors: a provider that picks its own selector name can have DKIM working while this says MISSING. ERROR means a DNS lookup timed out; try again.

Policy is the record's p= tag, null when no record was found.

Status is one of OK, WARNING, MISSING, ERROR.

Allowance is set on trial_allowance_exceeded: how many addresses a free trial may submit in total.

AvailableUsd is set on insufficient_allowance: what is left this month.

Error is the machine-readable code: insufficient_allowance, trial_allowance_exceeded, subscription_not_active, no_active_subscription or invalid_request.

Message is the human-readable explanation.

NeededUsd is set on insufficient_allowance: what the job would cost at the ceiling.

Remaining is set on trial_allowance_exceeded: how many of those addresses are still available. Zero is a real value, so it is a pointer.

Catchall accepts everything at the domain, so deliverability is likely but not proven.

EndTime in RFC3339, zero while the job is still running.

ErrorCode is empty on a healthy job. monthly_limit_reached means the allowance ran out and the remaining addresses came back unknown rather than missing; they are still in the download, marked.

Invalid will bounce.

MeterEvents is what the job has billed so far. Every check runs up to two providers and each one that answers is one event, so an address costs one event or two.

Name the job was created with.

Processed is how many have a verdict yet.

SpentUsd is MeterEvents priced at the meter rate: what this job adds to the invoice, not an estimate.

StartTime in RFC3339.

State is pending, running, done, failed or canceled.

Total addresses in the job.

Unknown got no verdict, so it was NOT billed. Usually a provider failure or the workspace's monthly verification allowance running out mid-job, in which case error_code says which.

Valid is deliverable.

What one first check costs.

PerAddressCeilingUsd is the most an address can cost: both providers answering. This is the common case, so budget against this one.

PerAddressFloorUsd is the least an address can cost: the first provider alone, which happens when it rejects the address outright.

What one second check costs.

Error is set when the address could not be answered.

What the first check said.

MeterEvents is what this address billed: 0, 1 or 2.

Result is valid, catchall_validated, invalid or unknown. The same four values a campaign's send-time gate uses, so an address checked here and one checked inside a campaign answer the same.

What the second check said. unknown means it never ran, which is what happens when the first check rejected the address outright, and nothing was billed for it.

Status is done, failed, skipped or pending.

VerifiedAt in RFC3339.

"0001-01-01T00:00:00Z" until the campaign is first launched.

MinimumHealth is what the campaign's minimum health score is doing: each connected account's score, which accounts it holds back and why. Null only when the scores could not be read this time.

"0001-01-01T00:00:00Z" while not set.

CustomVariables are the lead's merge tags beyond the named fields. Always present; null or empty when the lead has none.

MeetingBookedAt is when a meeting was explicitly marked as booked with this lead (see POST /leads/{id}/meeting) and null while no meeting is marked.

Tag is the lead's engagement category (interested, not_interested, bounced, out_of_office, delivery_incomplete, meeting_booked) and null while the lead has never been categorized.

AudienceSizedAt is when the audience size was last refreshed (RFC3339), or null when it has never been sized.

IsGenerated is true while the profile is exactly what the AI proposed; any human edit clears it.

IsPrimary marks the workspace's active profile. At most one per space.

Date is the UTC day.

Action is what to do about it. Every finding has one: a report that only says what is wrong makes the reader's day worse without improving their delivery.

Severity is critical, warning or info.

Code is inbox_placement_required or inbox_placement_hypergrowth_required.

Error is written for a person to read and can be shown as-is.

Tier is the tier the workspace currently holds: none, growth or hypergrowth.

WindowDays is how far back the rates below were computed over.

DeliverySeconds is how long the probe took to appear. -1 when never detected. A slow delivery is itself a signal: greylisting and throttling both show up here before they show up in a placement number.

Placement is pending, inbox, spam, promotions, social, updates, missing or failed.

InboxRate is the whole-percentage share of SCORED probes that reached the primary inbox. -1 when nothing has been scored.

Missing counts probes never found in any folder, which usually means a silent block. Reported apart from spam because it is a worse problem with a different fix.

Promotions counts every Gmail category tab: promotions, social and updates. Delivered, but filtered away from the reader.

SpamScore is the content spam score in tenths of a point, so 47 is 4.7. -1 when not scored.

Status is pending, sending, collecting, completed, failed or cancelled. Counters are only final once status is completed.

Trigger is manual or scheduled.

InboxRate is the whole-percentage share of SCORED probes that reached the primary inbox. -1 when nothing has been scored.

Missing counts probes never found in any folder, which usually means a silent block. Reported apart from spam because it is a worse problem with a different fix.

Promotions counts every Gmail category tab: promotions, social and updates. Delivered, but filtered away from the reader.

SpamScore is the content spam score in tenths of a point, so 47 is 4.7. -1 when not scored.

Status is pending, sending, collecting, completed, failed or cancelled. Counters are only final once status is completed.

Trigger is manual or scheduled.

Points is the rule's cost in tenths of a point, so 15 is 1.5 points.

IntervalHours is how often a recurring test repeats. Null for one-time.

Kind is one_time or recurring.

SeedProviders restricts the seed panel. Empty means every provider.

SenderEmailIDs are the mailboxes the test sends from.

google | microsoft | other

APIKey is the caller's Instantly.ai API key.

ImapCsvTemplate is a ready-to-fill CSV (one row per account, password column empty) for the bulk IMAP/SMTP connection flow.

APIKey is the caller's Instantly.ai API key. It is validated with a lightweight call to Instantly before the import job is enqueued.

Reason is recorded in the run's audit trail. Trimmed and capped at 200 characters.

MeetingBookedAt is when the meeting was marked as booked and null while no meeting is marked.

Tag is the lead's engagement category and null while the lead has never been categorized.

Error is the machine code: invalid_filters or invalid_request (400), insufficient_credits (402), plan_required (403), not_found or campaign_not_found (404), provider_unavailable or import_running (409), results_expired (410), contact_cap_reached (422), rate_limited or budget_exhausted (429), internal (500).

ImportID is the running import an import_running refusal waits on.

Reason details the code. invalid_filters: unknown_value, too_many_values, value_too_long, invalid_domain, mixed_geo_levels, location_needs_country, no_filters, unknown_field or malformed. 429: searches_per_minute, empty_searches, daily_preview_limit, running_imports, daily_import_limit, daily_budget, monthly_budget or fair_use_floor.

CreditsPerProspect is what adding one person to a campaign costs, read from the pricing table at request time.

CompanyKeywords is one phrase matched against what the employer does.

CompanyName is one phrase matched against the employer's name.

CompanySizes are headcount bands from GET /lead-finder/filters.

Countries, Regions and Continents are values from GET /lead-finder/filters, where the person is. Use one of the three at a time.

Domains and ExcludeDomains are company domains, up to 1,000 each.

HeadquartersCountries are where the employer is headquartered.

Industries are values from GET /lead-finder/filters.

JobFunctions are values from GET /lead-finder/filters.

JobTitles are free text, matched as OR terms.

Revenue is revenue bands from GET /lead-finder/filters.

Seniorities are values from GET /lead-finder/filters.

States and Cities are free text, matched inside the person's location.

Technologies are free text: tools the employer uses.

AudienceKey names the filters the people came from, as on a search.

CreditsSpent is what the import has charged so far. People added while the workspace's credits were free add nothing to it.

EndReason says how an import ended: all_selected or requested_reached (finished), audience_exhausted or fetch_limit (a first_n import stopped early), or canceled. A failed import has none; see LastError.

LastError says why a failed import stopped: insufficient_credits, contact_cap_reached, results_expired, budget_exhausted, provider_blocked, provider_unavailable (the people database was down or in maintenance; start the import again later), rate_limited, invalid_filters, campaign_not_found or internal. A failed import can still have added and charged people.

SkipReasons counts skipped people by reason: already_in_workspace, blocklisted, reveal_returned_no_address, consumer_mailbox, invalid_email or contact_cap_reached.

StartsAt is the position in the results a first_n import started from.

Status is running, completed, failed or canceled. Added, CreditsSpent and Status can still change until FinishedAt is set.

TopUpOf is set on an import a saved search's weekly top-up started (set up in the app): the saved search's id.

AudienceKey names the import's filters, as on a search.

Available is the wallet's spendable balance when the import started. While the workspace's credits are free (unlimited on GET /credits/balance) it is the workspace's own balance, which the import does not use.

EstimatedCredits is Requested x CreditsPerProspect, the most this import can cost in credits. Skipped people cost no credits; metered verification is billed separately.

Expired counts refs that were no longer stored and were dropped.

Requested is how many people the import will try to add.

StartsAt is the position in the results a first_n import starts from: 1 is the first person. Left out for a selected import.

CampaignID is the campaign the people are added to.

Count is how many people to add, for mode first_n: 1 to 5,000.

Filters are the filters to add from, for mode first_n. At least one include filter is required; the rules are those of a search. For mode selected they are optional: the search the refs came from, so the people count towards what those filters have added (progress on a search).

FromStart makes a first_n import start from the top of the results instead of after the last first_n import of the same filters.

Mode is "selected" (add the people named in Refs) or "first_n" (add up to Count people matching Filters who are not in the workspace yet, continuing after the last first_n import of the same filters).

Refs are result refs from searches, for mode selected: 1 to 1,000.

VerifyEmails checks each address with the paid verification waterfall before it is added: one or two metered checks per address, billed on the next invoice (GET /email-verification/rates), including addresses that turn out invalid. Invalid addresses are skipped and cost no credits; catch-all and unconfirmed ones are added and charged, and so is every address once the monthly verification allowance is used up. Defaults to true.

MaxSavedSearches and MaxSavedSearchName bound the searches a workspace saves in the app, and TopUpHourUTC is the hour of the day, in UTC, a saved search's weekly top-up runs.

RowsLeftToday is what is left of it this UTC day.

RowsPerDay is the account's daily browsing allowance in result rows.

InWorkspace is true for someone Lead Finder added to this workspace whose lead is still there, so adding them again is skipped for free. A person who is a lead from another source shows false; adding them is still skipped and costs nothing.

Ref identifies the person for POST /lead-finder/imports. It stays valid for 60 minutes after the page it came on was last shown.

LogoURL is the company's icon, an image of at most 64 pixels served by this API with no key needed. The URL does not contain the company's domain. It is left out when the company has no website on record, and answers 404 when the website has no icon.

Added is how many people they added.

Adds is how many imports there were, selected ones included.

LastAddAt is when the latest import from these filters started.

NextFrom is the position in the results (1 is the first person) the next first_n import of these filters starts from.

RunningImportID is a first_n import of these filters still running. Another first_n import of the same filters is refused (409 import_running) until it ends.

AudienceKey names the filters: the same picks in any order give the same key. Imports from these filters carry it too.

Error is set on a failed search: rate_limited, provider_blocked, provider_unavailable (the people database is down or in maintenance; try again later), timeout, invalid_filters, budget_exhausted, expired or internal.

Progress is what earlier imports from these filters did in the workspace. Left out before the first one.

Results are the people on this page, masked.

RowsLeftToday is the account's browsing allowance left this UTC day.

Status is running, done or failed.

Total is how many people match; TotalIsExact says whether it is a count or a lower bound, and TotalStatus whether the count has landed (pending, done or failed).

Filters: at least one include filter is required. Enum fields take values from GET /lead-finder/filters. Free-text fields take up to 50 values of up to 100 characters each, and a value holding commas is split into one term per comma. Use only one of countries, regions and continents; states and cities go with countries or on their own. A broken rule is a 400 invalid_filters naming the field, value and reason.

Page is 1-based, up to limits.maxPage. Defaults to 1.

PageSize is 25 (the default) or 50.

CustomVariables holds any attribute the eight named fields do not cover, for example the page a visitor landed on. Each key becomes a merge tag usable in email copy as {key}. Keys are matched case-insensitively with spaces treated as underscores, so "Page Visited" and "page_visited" are the same tag. Values are stored as given; non-string values are rendered with their JSON representation at send time.

Saved when the lead is created. Not changed when a lead with this email already exists.

CustomVariables are the lead's merge tags beyond the named fields.

MeetingBookedAt is when a meeting was explicitly marked as booked with this lead (see POST /leads/{id}/meeting) and null while no meeting is marked.

Tag is the lead's engagement category (interested, not_interested, bounced, out_of_office, delivery_incomplete, meeting_booked) and null while the lead has never been categorized.

Hosts are the domain's mail servers as "preference host", lowest preference (highest priority) first.

Status is one of OK, WARNING, MISSING, ERROR.

Meetings counts leads marked as having booked a meeting in the window.

PositiveReplies counts leads whose reply was categorized as interested.

CampaignID echoes the campaign filter when one was given. Only the outcome side is narrowed by it; spend stays workspace-level.

CostPerMeeting is total spend divided by meetings, null when there are none.

CostPerPositive is total spend divided by positive replies, null when there are none.

CostPerReply is total spend divided by replies, null when there are none.

Since echoes the window start, or null when the window is open-ended.

Until echoes the window end, or null when the window is open-ended.

Credits is the total of settled credit debits in the window. In-flight reservations are excluded until they settle.

CreditsUsd values the spent credits at the list price per credit.

DfyOrders is how many done-for-you orders were placed in the window (failed and canceled orders are excluded).

Code is machine-readable:

• invalid_request: malformed body or credits outside 1000..10000; fix the request. No charge was made.
• billing_required: the workspace has no active subscription with a saved default card; fix billing in the Emailchaser app, then retry. No charge was made.
• payment_failed: the charge was attempted and refused (declined, expired, insufficient funds); fix the card, then retry. No money moved.
• credits_free: this workspace's credits are free, so there is nothing to buy. No charge was made.
• temporarily_unavailable: the purchase stopped before any charge because a check could not be read. No charge was made; retry shortly.
• purchase_incomplete: the card WAS charged but crediting failed; support is already notified. Do NOT retry - a retry charges again.
• purchase_unconfirmed: the outcome is unknown, or the purchase completed but the new balance could not be read; check /credits/transactions for a stripe_topup entry before retrying.

Credits is how many prospect credits to buy. Minimum 1000, maximum 10000 per call.

AmountUsd is what the saved default payment method was charged, in US dollars.

CreditsPurchased is how many credits were bought and granted.

NewBalance is the available credit balance after the grant.

Signature omitted keeps the campaign's current signature; pass an empty string to clear it. Editing one body should not silently drop a signature the caller never asked about.

InReplyToEmailID is the inbound reply this draft answers. It is null in the rare case the draft's conversation can no longer be resolved (e.g. the inbound email was deleted).

To and Cc are who the draft goes to when sent, as Reply All does it: the person who wrote the reply in To, and everyone else they addressed (their To and Cc lines, minus your workspace's own mailboxes) in Cc.

CampaignID is null for standalone replies that could not be attributed to a campaign.

ResponseCategory is null while AI categorization is still pending.

CheckedAt is when the live DNS lookups ran (this request).

Health score 0-100, higher is better: the share of this account's warm-up emails over the last 7 full days that landed in the inbox rather than spam; 90+ is the app's bar for campaigns. It moves daily as warm-up emails land in the inbox (up) or in spam (down). Null while warm-up is off or before 20 warm-up emails were checked. The same number the app shows as the account's health score.

The account's last 20 connection events, newest first. Null in the response to PUT /sender-emails/{id}.

Health score 0-100, higher is better: the share of this account's warm-up emails over the last 7 full days that landed in the inbox rather than spam; 90+ is the app's bar for campaigns. It moves daily as warm-up emails land in the inbox (up) or in spam (down). Null while warm-up is off or before 20 warm-up emails were checked. The same number the app shows as the account's health score.

ActivatedAt is when warm-up was first switched on; the ramp counts days from here. Null until then.

CapLimit is the most warm-up emails a day; the ramp stops here.

Configured is true once the mailbox has warm-up settings of its own. While false the mailbox has never been enrolled, and the values below are the defaults that switching warm-up on would use.

CurrentPerDay is today's ramp target, 0 while warm-up is off. On a weekend a weekdays-only mailbox still shows its ramp value, although no warm-up emails send that day.

EnableReplies lets warm-up recipients reply, adding reply signals.

Enabled is true while the mailbox is warming.

Health score 0-100, higher is better: the share of this account's warm-up emails over the last 7 full days that landed in the inbox rather than spam; 90+ is the app's bar for campaigns. It moves daily as warm-up emails land in the inbox (up) or in spam (down). Null while warm-up is off or before 20 warm-up emails were checked.

IncreaseBy is how many warm-up emails are added each day until CapLimit.

StartLimit is how many warm-up emails go out on the first day.

Timezone is the IANA timezone the warm-up send window runs in.

WeekdaysOnly limits warm-up sending to Monday through Friday.

Cap is the configured maximum warm-up emails per day; the ramp stops there. 0 while the mailbox has never been enrolled.

CurrentPerDay is today's warm-up ramp target (warm-up emails per day), 0 while not enrolled. On weekends of a weekdays-only account the ramp value still shows even though no warm-up emails send that day.

Enrolled is true while the mailbox has warm-up enabled.

Health score 0-100, higher is better: the share of this account's warm-up emails over the last 7 full days that landed in the inbox rather than spam; 90+ is the app's bar for campaigns. It moves daily as warm-up emails land in the inbox (up) or in spam (down). Null while warm-up is off or before 20 warm-up emails were checked.

BlacklistsChecked is how many zones were queried, reported next to the listing count so the number can never be read as a total.

HealthScore is 0-100 combining placement, authentication and blacklist standing. -1 when it cannot be computed.

PlacementScore is the inbox rate over recent completed runs. -1 when the mailbox has never been tested.

SendingIP is empty for mailboxes on a shared provider (Gmail, Microsoft), which have no dedicated IP of their own to check.

Each status is OK, WARNING, MISSING or ERROR.

To and Cc are who the reply is being sent to (see ReplyDraftItem).

Agent is the assistant's self-reported name, in any form; the backend normalizes it to a short lowercase identifier.

CampaignID is the campaign the sourced prospects are added to.

Count is how many prospects to add in this request. Defaults to 50, capped at 500. A stored prospect costs the reveal price in credits (1 at the time of writing); the response states the price it charged and the total the batch is expected to cost, so nothing has to trust this comment to stay current.

IcpID names the Ideal Customer Profile whose targeting criteria drive the search. Omitted, the workspace's primary profile is used.

CreditsPerProspect is what one stored prospect debits, read from the pricing table at request time. It is reported because the price has changed twice (1 to 5 in August 2026, back to 1 in September 2026 when the contact data moved to a flat monthly plan) and every caller that budgets from a hardcoded number budgets wrong the day it changes again.

EstimatedCredits is Requested x CreditsPerProspect: the ceiling this batch can cost. The run settles against prospects actually stored, so the real debit is this or less.

IcpID is the profile that was used, echoed back so callers relying on the primary-profile default can see which one it resolved to.

ProspectSearchID identifies the search being advanced. Repeated requests for the same campaign and profile return the same id: the search resumes from its provider cursor instead of re-revealing the same people.

Status is one of OK, WARNING, MISSING, ERROR.

BudgetUsd, when given, sizes a budget plan that is snapshotted on the run. The plan's domain and mailbox counts are a ceiling for what the run buys after approval (one order holds at most 10 domains and can place fewer mailboxes), and its dollar figures are an estimate.

MaxMailboxes caps the budget plan's infrastructure. 0 means no cap.

ReplyMode is how inbound replies are handled: off, draft (default), approve, or auto. Auto sends AI reply drafts for interested replies without review - opt in deliberately.

TargetProspects is how many prospects the run reveals per sourcing batch: the first batch once the run is approved, then each top-up. No prospect is revealed and no credit is spent before approval. When omitted and a budget is given, it is derived from the budget plan; when 0 or omitted without a budget, the runner default batch applies.

Website is the company website the run is seeded from.

Country is an ISO 3166-1 alpha-2 code, e.g. US. Case-insensitive on input.

PhoneCc is the telephone country calling code without the plus, e.g. 1.

DailyLimit caps the total emails (initial + follow-ups) this campaign may schedule per calendar day in the campaign timezone. Omit to leave the cap unchanged; it cannot be cleared through this endpoint.

Settings - all optional boolean flags

MinimumHealthScore, 1-100, is the lowest email account health score (see healthScore on the sender emails) that may send in this campaign. An account below it, or with no score yet, sends nothing here, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. Send 0 to remove the minimum; omit to leave it unchanged. A running campaign re-plans its unsent emails at once.

DaysSchedule is the set of weekdays the campaign may send on. Accepts weekday numbers as strings, where Sunday is 0 ("1" is Monday), or weekday names such as "monday". Names are matched case-insensitively and common short forms ("mon", "tues") work. It is sent as an array, but stored as numbers and returned as one comma-separated string: a request sending Monday to Friday by name reads back as "1,2,3,4,5".

For multiple leads scheduled campaigns (flow 3) and API campaigns.

For single lead scheduled campaigns (flow 2)

Common field for all flows

CustomVariables is returned only for a lead in no campaign.

Category must be one of the lead category values: interested, not_interested, bounced, out_of_office, delivery_incomplete, meeting_booked.

CustomVariables replaces the lead's whole custom variable map when provided. Omit it to leave the existing variables untouched.

For a lead in a campaign, a different email does not change this lead: it creates a lead with the new email in the same campaign, or overwrites the lead that already has it.