Sendfox integration: operations for AI agents
Sendfox connects to Type.com as an integration. This page lists the 72 operations documented for Claude and Codex in Type.com: 32 read, 24 write, 16 destructive.
About Sendfox
SendFox vendor API references, subject to account permissions.
Categories: Marketing & Social
How to connect Sendfox to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
72 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
72 operations listed.
Contacts
- Read
List contacts
Returns a paginated list of contacts (100 per page by default, up to 1000 via `per_page`). Supports engagement filtering through `filter[...]` query parameters, so you can answer questions like "who last opened over a year ago" without paging the whole account. All filter conditions are AND-ed. Pass `count_only=true` to get just the number of matches — the cheapest way to size an audience before acting on it.
GET /contacts - Read
Get a specific contact
Get a specific contact
GET /contacts/{id} - Read
Get email activity for a contact
Returns paginated email deliverables and contact-level engagement summary
GET /contacts/{id}/activity - Read
Check the progress of a bulk contact action
For a dry run, matched_count is the answer and nothing was modified. A run whose match set exceeds the per-request ceiling fails without applying anything.
GET /contacts/bulk-actions/{id} - Read
List unsubscribed contacts
List unsubscribed contacts
GET /contacts/unsubscribed - Write
Create a new contact
Create a new contact
POST /contacts - Write
Batch import contacts
Import up to 1,000 contacts in a single request. Creates new contacts or updates existing ones.
POST /contacts/batch - Destructive
Update a contact
Update contact details including name, list memberships, and custom fields
PATCH /contacts/{id} - Destructive
Delete a contact
Soft-deletes a contact and cancels any scheduled deliverables
DELETE /contacts/{id} - Destructive
Apply a tag or list change to every contact matching a filter
Queues one action against every contact the filter matches, applied in chunks in the background. Returns immediately with an id to poll. **Run with `dry_run: true` first.** A dry run reports how many contacts match and changes nothing — it is the only way to catch a filter that matches more than intended, and a bulk write is not undoable. An empty filter (which would match the whole account) is rejected unless it is a dry run. Per-campaign conditions (`opened_campaign_id`, `not_opened_campaign_id`, `clicked_campaign_id`) are available here but not on `GET /contacts`, because they are resolved in the background rather than inside a request. Bulk delete and bulk unsubscribe are deliberately not offered. Because `in_list_ids` matches only subscribed members, `remove_from_list` with `filter.in_list_ids` set to that same list leaves the memberships of people who unsubscribed from it in place. They already receive nothing from that list. `tag_ids` behaves the same way, so `remove_tag` with `filter.tag_ids` set to that same tag leaves the tag on people who unsubscribed from it. They already receive nothing sent to that tag. To reach every carrier regardless of opt-out status, select them by some other filter, or read them from the tag endpoints.
POST /contacts/bulk-actions - Destructive
Unsubscribe a contact by email
Unsubscribes the contact by email at account-wide level.
PATCH /unsubscribe
Contact Tags
- Read
List contact tags
Lists the account's tags, newest first, each with its contact count. Distinct from the legacy /tags endpoints, which operate on lists.
GET /contact-tags - Read
Get a contact tag
Get a contact tag
GET /contact-tags/{id} - Read
List a contact's tags
List a contact's tags
GET /contacts/{contact_id}/tags - Write
Create a contact tag
Creates a tag. A brand color is auto-assigned when none is provided. Tag names are unique per account.
POST /contact-tags - Write
Update a contact tag
Update a contact tag
PATCH /contact-tags/{id} - Write
Attach a tag to a contact
Idempotent. Returns the contact's tags after the change.
POST /contacts/{contact_id}/tags/{tag_id} - Destructive
Delete a contact tag
Deletes the tag. Tagged contacts are kept — only the tag and its attachments (including campaign audience use) are removed. Returns 409 if an automation starts on the tag or adds/removes it.
DELETE /contact-tags/{id} - Destructive
Remove a tag from a contact
Remove a tag from a contact
DELETE /contacts/{contact_id}/tags/{tag_id}
Campaigns
- Read
List campaigns
Returns a paginated list of campaigns (100 per page)
GET /campaigns - Read
Get statistics for multiple campaigns
Returns stored counts and rates for one to 100 distinct owned campaigns in request order. The entire request fails with the same validation error for missing, deleted or foreign IDs. Does not return link stats or query individual delivery events.
GET /campaigns/stats - Read
Get a specific campaign
Get a specific campaign
GET /campaigns/{id} - Read
Get campaign performance statistics
Returns sent count and open/click/bounce/unsubscribe/spam counts and rates, all read from stored counters. Pass `include_link_stats=true` to also get `link_stats` — the campaign's links ranked by click count. That part is opt-in because it counts rows in `email_link_clicks` once per link rather than reading a counter, so leaving it off keeps this endpoint as cheap as it has always been.
GET /campaigns/{id}/stats - Read
List the contacts behind a campaign's engagement
Returns the contacts in one of a sent campaign's engagement groups. non_openers covers contacts the campaign actually sent to who did not open it — queued and cancelled deliverables are excluded, since they never had the chance.
GET /campaigns/{id}/engagement - Write
Create a new campaign
Creates a campaign as a draft. To send it, use the send endpoint or provide scheduled_at. Subject lines cannot start with "RE:" or "FWD:". At least one list is required if scheduled_at is provided.
POST /campaigns - Write
Update a draft campaign
Only draft campaigns (not yet sent) can be updated. All fields are optional.
PATCH /campaigns/{id} - Write
Send a campaign immediately
Schedules a draft campaign for immediate sending. The campaign must: - Not already be sent or scheduled - Have at least one list assigned - Not be a confirmation (double opt-in) email — those are delivered to each contact as they subscribe, never as a broadcast - The user must not be in a warmup/throttle period All existing abuse prevention applies automatically: content approval workflow, sending throttles, spam detection, and bounce rate monitoring.
POST /campaigns/{id}/send - Write
Send a test of a campaign
Delivers the rendered campaign to the addresses given so it can be checked in a real inbox. This is a real send to those addresses only: the campaign's audience is untouched and the campaign stays a draft. Recipients are added to the account's "My Test Contacts" list. Limits: up to 30 addresses per call (1 on the free plan) and 30 test sends per account per day, shared with Send Test in the SendFox app. A test from a newly created account goes to the account's own address only, unless the campaign sends from a domain the account has verified; `notice` in the response says so when addresses were dropped.
POST /campaigns/{id}/send-test - Write
Clone a sent campaign at part of its original audience
Creates a new draft with the original's content, sender, and exclusions, aimed at the chosen slice of the original audience. Omit scheduled_at to leave it as a draft. The source campaign's lists are deliberately not carried over — the engagement segment is the audience.
POST /campaigns/{id}/resend - Destructive
Delete a draft campaign
Only draft campaigns (not yet sent) can be deleted. Uses soft delete.
DELETE /campaigns/{id}
Forms
- Read
List forms
List forms
GET /forms - Read
Get a specific form
Get a specific form
GET /forms/{id} - Write
Create a new form
Creates a subscription form linked to one or more lists. Free users are limited to 1 form.
POST /forms - Write
Update a form
Update a form
PATCH /forms/{id} - Destructive
Delete a form
Soft-deletes the form
DELETE /forms/{id}
Users
- Read
Get current user information
Get current user information
GET /me
Content Library
- Read
List saved campaign templates
Returns only content owned by the authenticated account, including saved HTML. Shared gallery content is not included. This endpoint does not publish, modify or send content. Results are ordered by descending ID, 20 per page.
GET /campaign-templates - Read
Get a saved campaign template
Returns only content owned by the authenticated account, including saved HTML. Shared gallery content is not included. This endpoint does not publish, modify or send content.
GET /campaign-templates/{id} - Read
List saved campaign sections
Returns only content owned by the authenticated account, including saved HTML. Shared gallery content is not included. This endpoint does not publish, modify or send content. Results are ordered by descending ID, 20 per page.
GET /campaign-sections - Read
Get a saved campaign section
Returns only content owned by the authenticated account, including saved HTML. Shared gallery content is not included. This endpoint does not publish, modify or send content.
GET /campaign-sections/{id}
Contact Fields
- Read
List user contact fields
Returns custom contact fields defined by the user (20 per page)
GET /contact-fields - Read
Get a specific contact field
Get a specific contact field
GET /contact-fields/{id} - Write
Create a custom contact field
Creates a custom field for contacts. The `name` is auto-generated from the `label` as a slug. Provide `type` (`text`, `number`, or `date`) or the existing `contact_field_type_id` UUID. If both are provided, they must identify the same type. UUIDs are the same for every account: | Type | `contact_field_type_id` | | ------ | -------------------------------------- | | text | `0abe5601-7738-43c8-858f-81911ecf89ee` | | number | `e43c6471-b3ff-4541-80c5-964c62decd15` | | date | `fe7dd76c-5113-4159-bc7c-0dbf0ed8d404` | The value is immutable after creation and is not returned by any endpoint - responses carry the human-readable `type` (`text`, `number`, `date`) instead.
POST /contact-fields - Write
Update a contact field label
Updates the label and auto-regenerates the name slug. Note: `contact_field_type_id` is immutable and cannot be changed after creation.
PATCH /contact-fields/{id} - Destructive
Delete a contact field
Permanently deletes the contact field
DELETE /contact-fields/{id}
Lists
- Read
List contact lists
List contact lists
GET /lists - Read
Get a specific contact list
Returns list details including average open and click rates
GET /lists/{id} - Read
Get everyone who has stopped this list
Members who no longer receive this list, and when they stopped. Each row is a Contact with two extra fields. The two timestamps are never merged. `list_unsubscribed_at` is this list only. `unsubscribed_at` keeps the meaning it has everywhere else in this API: the account-wide opt-out. Treating a per-list timestamp as an account-wide one would suppress that person across your whole integration because they left a single list, so read `unsubscribed_scope` if you need one field to branch on.
GET /lists/{list_id}/unsubscribes - Read
Get contacts in a list
Returns every contact on the list. This is membership, not subscription: someone who unsubscribed from the list is still a member and is still returned, so that an integration mirroring this endpoint can tell "removed from the list" apart from "asked to stop receiving it". Pass `status` to narrow it.
GET /lists/{list_id}/contacts - Write
Create a new contact list
Create a new contact list
POST /lists - Write
Update a contact list
Update a contact list
PATCH /lists/{id} - Write
Add a contact to a list
Adds an existing contact to a list. If the contact is already in the list, no duplicate is created.
POST /lists/{list_id}/contacts - Destructive
Delete a contact list
Soft-deletes a list. Returns 409 if the list is used by forms, landing pages, or automations.
DELETE /lists/{id} - Destructive
Unsubscribe a contact from one list
Stops this one list for this one contact. Their other lists and their account-wide status are untouched, which is what distinguishes this from `PATCH /unsubscribe` — that endpoint is account-wide and is unchanged. Idempotent. Repeating the request returns the original timestamp rather than moving it, so a retry never loses the date the person actually asked. The opt-out is recorded durably, so it survives the contact being removed from the list and added back: re-adding them does not start sending again. There is no matching resubscribe endpoint. Taking consent away on someone's behalf is safe for an integration to do; handing it back is not.
PATCH /lists/{list_id}/unsubscribe - Destructive
Remove a contact from a list
Remove a contact from a list
DELETE /lists/{list_id}/contacts/{contact_id}
Domains
- Read
List sender domains
Returns a paginated list of the user's whitelabel/sender domains. Sending domains are shared by marketing campaigns and transactional email. Every Domains endpoint accepts a paid-plan API key or a transactional key that carries the `transactional:domains` scope. A transactional key without that scope gets a 403 in the transactional error shape (`insufficient_scope`), and one on an account without transactional access gets `feature_not_available`.
GET /domains - Read
Get domain with DNS records
Returns domain details including DNS records needed for verification
GET /domains/{id} - Write
Add a sender domain
Adds a new sender domain and creates the corresponding SendGrid whitelabel domain. Requires a provisioned SendGrid subuser; accounts get one shortly after signup.
POST /domains - Write
Validate domain DNS records
Triggers DNS validation for the domain via SendGrid. Returns whether validation passed and any errors for specific DNS records.
POST /domains/{id}/validate - Destructive
Delete a sender domain
Removes the domain from SendGrid and soft-deletes locally
DELETE /domains/{id}
Automations
- Read
List automations
List automations
GET /automations - Read
Get a specific automation
Returns automation with triggers, items, and campaign stats
GET /automations/{id} - Write
Create an automation
Create an automation
POST /automations - Write
Add an email to an automation
Add an email to an automation
POST /automations/{id}/emails - Write
Update an automation email
Update an automation email
PATCH /automation-emails/{id} - Destructive
Update an automation
Update title, trigger, or active status. Activating reschedules stale deliverables.
PATCH /automations/{id} - Destructive
Delete an automation
Soft-deletes the automation and cancels all scheduled deliverables
DELETE /automations/{id} - Destructive
Remove an email from an automation
Remove an email from an automation
DELETE /automation-emails/{id}
Transactional
- Read
List emails
Newest first. Standard SendFox paginator; bodies are never included.
GET /transactional/emails - Read
Get an email
The message without its bodies, plus its event timeline.
GET /transactional/emails/{id} - Write
Send an email
Queues one email. The response is immediate; delivery happens in the background and is reported through `GET /transactional/emails/{id}` and your webhook. **Idempotency.** Send an `Idempotency-Key` header (1 to 256 characters) to make retries safe. Within 24 hours, the same key with the same body returns the original message (with an `idempotent-replayed: true` header); the same key with a different body is a `409 invalid_idempotent_request`. **Sandbox.** Send from `onboarding@sendfoxmail.com` with no DNS setup. It delivers only to your own account email and to the four test addresses. Test addresses never reach a mailbox and never count toward your limits; each one synthesizes an outcome so you can exercise your integration: `delivered@sendfoxmail.com`, `bounced@sendfoxmail.com`, `complained@sendfoxmail.com`, `suppressed@sendfoxmail.com`. **Limits.** Transactional email has no quota of its own: every address in `to`, `cc` and `bcc` counts as one send against your SendFox plan, the same monthly sends your campaigns use, with no daily cap. When the plan has a cap, every response carries `x-sendfox-sends-remaining`, the sends left across campaigns and transactional email; a plan without an enforced cap sends no header. Past the cap, sends are refused with `429 monthly_quota_exceeded` carrying `remaining` and `requested`. Each message holds at most 10 addresses across `to`, `cc` and `bcc`, at most 2 in `bcc`. Requests are limited to 5 per second and 300 per minute per key. **Custom headers.** Pass `headers` to add list-management and threading headers. For one-click unsubscribe (RFC 8058, which Gmail and Yahoo require of bulk senders) send `List-Unsubscribe` with an `https:` URL in angle brackets and `List-Unsubscribe-Post` set to `List-Unsubscribe=One-Click`; the URL must accept a `POST` whose body is `List-Unsubscribe=One-Click` and unsubscribe the recipient without any further click. See the `headers` field for what is allowed.
POST /transactional/emails - Write
Send a batch of emails
Queues up to 100 emails in one request and reports a result per item. Items are independent: one invalid address, unverified sender or suppressed recipient is reported at its `index` and the rest are queued. The response is `200` whenever the batch itself was accepted, even if every item was refused; read each entry's `error`. **Limits.** The whole batch's sends (one per `to`, `cc` and `bcc` address across every item) are reserved against your plan before any item is looked at. A batch that does not fit is refused with `429 monthly_quota_exceeded` and nothing is sent, so a retry can never half-send. Sends for refused items, test addresses and replays are returned. A batch request counts as one request against the 5 per second and 300 per minute rate limit; the plan's sends are what bound volume. **Idempotency.** Two levels. An `Idempotency-Key` header makes the whole batch replayable for 24 hours: the same key with the same `emails` returns the original results with `idempotent-replayed: true`; a different body is a `409 invalid_idempotent_request`. A per-item `idempotency_key` protects each email on its own, exactly like the header on `POST /transactional/emails`, and is the one to rely on when your retry may be built from a different batch. Sandbox, test addresses and tags work per item as on the single route.
POST /transactional/emails/batch
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 29, 2026. Sendfox API docs.