GET ?space_id= : the space's campaigns, newest first (filters: status, enrollment_mode). POST {space_id, name, connection_instance_id, connector_slug, from_email, from_name?, reply_to?, audience_query_string?, enrollment_mode?, steps}: create a draft. Launch it with campaigns/<id>/launch/.
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/
Service tierhttps://sales.mattering.io/api/internal/campaigns/
Body keys (JSON)
Key
Required
Default
audience_query_string
optional or conditional
none
cold_settings
optional or conditional
none
connection_instance_id
optional or conditional
none
connector_slug
optional or conditional
none
enrollment_mode
optional or conditional
none
from_email
optional or conditional
none
from_name
optional or conditional
none
name
optional or conditional
none
physical_address
optional or conditional
none
reply_to
optional or conditional
none
sender_mailbox_ids
optional or conditional
none
sending_mode
optional or conditional
none
space_id
optional or conditional
none
steps
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Pagination
Accepts limit and offset. The response meta carries total, returned, has_more and next_offset.
The organization's active email-sending connections (Postmark, Mailgun, SMTP), for connection_instance_id + connector_slug on create. 503 when the connector service can't be reached.
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/connections/
Service tierhttps://sales.mattering.io/api/internal/campaigns/connections/
The workspace postal address every cold email's footer carries (a campaign's own ``physical_address`` overrides it). GET ?space_id=; PATCH {space_id, address_line1?, address_line2?, city?, state?, postal_code?, country?}. ``complete`` says whether it is enough to launch (street, city or postal code, country).
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/mailing-address/
Service tierhttps://sales.mattering.io/api/internal/campaigns/mailing-address/
Query parameters
Name
Default
space_id
none
Body keys (JSON)
Key
Required
Default
address_line1
optional or conditional
none
address_line2
optional or conditional
none
city
optional or conditional
none
country
optional or conditional
none
postal_code
optional or conditional
none
space_id
optional or conditional
none
state
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
GET ?space_id= : the caller's own connected mailboxes in the space, each with ``eligible`` / ``problem`` for cold sending and its sending stats (sent today, cap, today's limit while ramping, paused + reason, staff review, recent bounce and opt-out rates).
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/sender-mailboxes/
Service tierhttps://sales.mattering.io/api/internal/campaigns/sender-mailboxes/
GET: one of the caller's mailboxes with its cold sending stats and warmup. PATCH {daily_cap?: 1-100 | null, dkim_selector?: str | null, resume?: true}: change its cap (raising it is a material change for the cold sequences using it), set a custom DKIM selector for the readiness check (blank or null: Google's default ``google``), or resume it after an automatic pause. Resuming is human only, and refused while the mailbox waits for staff review (``staff_review_required``).
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/sender-mailboxes/{mailbox_id}/
Service tierhttps://sales.mattering.io/api/internal/campaigns/sender-mailboxes/{mailbox_id}/
Path parameters
Name
Type
mailbox_id
uuid
Body keys (JSON)
Key
Required
Default
daily_cap
optional or conditional
none
dkim_selector
optional or conditional
none
resume
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
POST: re-run the sending-domain readiness checks for one of the caller's mailboxes now (SPF, DKIM at its selector, DMARC, MX, Spamhaus DBL, domain age). At most once per 5 minutes per mailbox: a repeat is 429 ``readiness_rate_limited`` with ``retry_after`` seconds. Returns the mailbox with its warmup (``warmup.readiness`` holds the checks).
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/sender-mailboxes/{mailbox_id}/readiness/
Service tierhttps://sales.mattering.io/api/internal/campaigns/sender-mailboxes/{mailbox_id}/readiness/
GET: one campaign. PATCH: change the keys sent. A draft can change anything; once launched only the name can change, except that a cold sequence can still change its steps, audience, mailboxes, settings and address: a material change (campaign_cold.material_changes) pauses it with ``pause_reason: reattestation_required`` until the owner attests again (meta.reattestation_required).
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/{campaign_id}/
Service tierhttps://sales.mattering.io/api/internal/campaigns/{campaign_id}/
GET: the statement to confirm (version, confirmations, LIA line), the current attestation, whether it is valid, pending material changes and the attestation history. POST {version, confirmations: {key: true} | [key], legitimate_interest_assessment?: bool}: the owner attests. Human only (``human_required`` 403 for agents and services). Re-attesting a sequence paused with reattestation_required resumes it.
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/{campaign_id}/attestation/
Service tierhttps://sales.mattering.io/api/internal/campaigns/{campaign_id}/attestation/
Path parameters
Name
Type
campaign_id
uuid
Body keys (JSON)
Key
Required
Default
confirmations
optional or conditional
none
legitimate_interest_assessment
optional or conditional
false
version
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Launch a draft: enroll the audience and start sending.
Refused with 409 ``{"error": "cold_recipients", "detail", "count", "stages"}`` when the audience holds contacts in stages that can't receive campaigns (Sales Campaigns only go to warm contacts). Send {"exclude_cold_stages": true} to exclude those stages from the audience and launch, the API form of "Exclude them and launch".
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/{campaign_id}/launch/
Service tierhttps://sales.mattering.io/api/internal/campaigns/{campaign_id}/launch/
Path parameters
Name
Type
campaign_id
uuid
Body keys (JSON)
Key
Required
Default
exclude_cold_stages
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
A campaign's recipients with status, skip reason and progress, paged. Filters: ``status``, ``skip_reason`` (code, prefix match so ``casl_canada`` matches ``casl_canada:email_domain``), ``email``.
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/{campaign_id}/recipients/
Service tierhttps://sales.mattering.io/api/internal/campaigns/{campaign_id}/recipients/
Path parameters
Name
Type
campaign_id
uuid
Pagination
Accepts limit and offset. The response meta carries total, returned, has_more and next_offset.
One recipient of a campaign; POST resumes, re-pauses or removes it.
GET: the recipient (status, progress, pause). POST {action: "resume" | "pause_until" | "remove", until?: "YYYY-MM-DD"}: override one contact's schedule. resume ends an out-of-office or manual pause (the next email goes out at the next sending slot); pause_until holds the next email until the sending window on that date (after today, at most 60 days out); remove takes the contact out of the sequence. Only for recipients still in the sequence (recipient_not_active 409); resume needs a paused one (not_paused 409). Each change writes a timeline entry on the contact.
URL
User APIhttps://sales.mattering.io/api/user/v1/campaigns/{campaign_id}/recipients/{recipient_id}/
Service tierhttps://sales.mattering.io/api/internal/campaigns/{campaign_id}/recipients/{recipient_id}/
Path parameters
Name
Type
campaign_id
uuid
recipient_id
uuid
Body keys (JSON)
Key
Required
Default
action
optional or conditional
none
until
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
This read is not paginated. It returns at most 255 rows and does not report a total, so a result of exactly 255 may be truncated.
URL
User APIhttps://sales.mattering.io/api/user/v1/email-events/inbound/
Service tierhttps://sales.mattering.io/api/internal/email-events/inbound/
Body keys (JSON)
Key
Required
Default
connector_instance_id
optional or conditional
none
from_email
optional or conditional
none
headers
optional or conditional
none
html_body
optional or conditional
none
in_reply_to
optional or conditional
none
metadata
optional or conditional
none
organization_id
optional or conditional
none
provider
optional or conditional
none
provider_message_id
optional or conditional
none
received_at
optional or conditional
none
subject
optional or conditional
none
text_body
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
GET: the space's suppression list, newest first. Filters: ``email`` (exact, any case), ``reason``, ``since`` (ISO date or datetime, created on or after). POST ``{space_id, email, reason, note?}``: add an address. Idempotent on space + email: a repeat returns the existing row (200, its original reason kept) instead of a second one (201).
URL
User APIhttps://sales.mattering.io/api/user/v1/suppressions/
Service tierhttps://sales.mattering.io/api/internal/suppressions/
Body keys (JSON)
Key
Required
Default
email
optional or conditional
none
note
optional or conditional
none
reason
optional or conditional
none
space_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Pagination
Accepts limit and offset. The response meta carries total, returned, has_more and next_offset.
We use strictly necessary cookies to run this site. With your permission we also use analytics cookies
(Google Analytics and our own visit tracking) to see which pages work. Read the
Cookie notice.