SendFox

App · 19 actions

Grow your SendFox audience: create contacts, add them to lists and tag them, read campaigns and their stats, automations and forms, and send transactional email.

Actions

ActionWhat it does
Add contact to listAdd an existing contact to a list.
Create contactCreate a contact with a name, lists to join and custom field values.
Get accountGet the SendFox account the connection uses: name, email, and how many contacts it has against its limit.
Get automationGet one automation with its triggers, the emails it sends, their delays and their stats.
Get campaignGet one campaign with its subject, HTML, sender and when it was scheduled or sent.
Get campaign statsGet a campaign's sends, opens, clicks, unsubscribes, bounces and spam reports, with rates, and optionally clicks per link.
Get formGet one sign-up form with its public link, redirect, GDPR setting and lists.
Get listGet one list with its subscribed and unsubscribed counts and average open and click rates.
Get stats for several campaignsGet sends, opens, clicks, unsubscribes, bounces and spam reports for up to 100 campaigns at once, in the order given.
Get transactional emailGet a transactional email's status, recipients and delivery events (sent, delivered, bounced and so on).
List automationsList your automations with whether each is on, what starts it, and the emails it sends.
List campaignsList your campaigns, 100 a page, with subject, sender, HTML and when each was scheduled or sent.
List contact fieldsList your custom contact fields with their labels, the names used to set them, and their types (text, number or date).
List contact tagsList your contact tags, newest first, with how many contacts each has.
List formsList your sign-up forms with their public links, optionally filtered by title.
List listsList your contact lists with subscriber counts and average open and click rates, optionally filtered by name.
List saved templatesList your saved campaign templates, 20 a page, newest first, optionally filtered by name.
Send transactional emailSend one email from your app, such as a receipt or login code, to up to 10 people.
Tag contactApply an existing tag to a contact.

Add contact to list

Add an existing contact to a list. A contact already on the list stays there once.

Inputs

Listlist_idtextRequired
The list. Pick one, or give its id from an earlier step.
Contact IDcontact_idtextRequired
The contact's id, from 'Create contact' or an earlier step.

Outputs

contactobject
The contact
list_idnumber
The list
Example output
{
  "contact": {
    "created_at": "2026-10-01T09:00:00Z",
    "email": "sam@example.com",
    "first_name": "Sam",
    "id": 5001,
    "ip_address": null,
    "last_name": "Lee",
    "unsubscribed_at": null,
    "updated_at": "2026-10-01T09:00:00Z"
  },
  "list_id": 2001
}

Create contact

Create a contact with a name, lists to join and custom field values. Returns the contact's id for later steps.

Inputs

EmailemailtextRequired
The contact's email address.
First namefirst_nametext
The contact's first name.
Last namelast_nametext
The contact's last name.
Listslistslist
Lists to add the contact to. Each must be active.
Custom fieldscontact_fieldsobject
Values for your account's custom contact fields.
IP addressip_addresstext
The IP address the contact signed up from, if you have it.

Outputs

contactobject
The new contact
Example output
{
  "contact": {
    "created_at": "2026-10-01T09:00:00Z",
    "email": "sam@example.com",
    "first_name": "Sam",
    "id": 5001,
    "ip_address": null,
    "last_name": "Lee",
    "unsubscribed_at": null,
    "updated_at": "2026-10-01T09:00:00Z"
  }
}

Get account

Get the SendFox account the connection uses: name, email, and how many contacts it has against its limit.

Inputs

None.

Outputs

userobject
The connected account
Example output
{
  "user": {
    "contact_limit": 1000,
    "contacts_count": 240,
    "created_at": "2026-10-01T09:00:00Z",
    "email": "jo@example.com",
    "id": 1001,
    "name": "Jo Bloggs",
    "updated_at": "2026-10-01T09:00:00Z"
  }
}

Get automation

Get one automation with its triggers, the emails it sends, their delays and their stats.

Inputs

Automationautomation_idtextRequired
The automation. Pick one, or give its id from an earlier step.

Outputs

automationobject
The automation
Example output
{
  "automation": {
    "active": true,
    "automation_items": [],
    "automation_triggers": [
      {
        "automation_id": 8001,
        "campaign_id": null,
        "contact_tag_id": null,
        "created_at": "2026-10-01T09:00:00Z",
        "id": 8101,
        "list_id": 2001,
        "type": "apply_list",
        "updated_at": "2026-10-01T09:00:00Z"
      }
    ],
    "created_at": "2026-10-01T09:00:00Z",
    "id": 8001,
    "title": "Welcome series",
    "updated_at": "2026-10-01T09:00:00Z",
    "user_id": 1001
  }
}

Get campaign

Get one campaign with its subject, HTML, sender and when it was scheduled or sent.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "created_at": "2026-10-01T09:00:00Z",
    "from_email": "jo@example.com",
    "from_name": "Jo Bloggs",
    "html": "<p>Hello</p>",
    "id": 6001,
    "is_web_gated": false,
    "preview_text": null,
    "scheduled_at": null,
    "sent_at": "2026-10-02T09:00:00Z",
    "subject": "What's new in October",
    "timezone": "UTC",
    "title": "October news",
    "updated_at": "2026-10-01T09:00:00Z"
  }
}

Get campaign stats

Get a campaign's sends, opens, clicks, unsubscribes, bounces and spam reports, with rates, and optionally clicks per link.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Include link clicksinclude_link_statstrue/false
Also list each link in the campaign with its click count.Default: false.
Most linkslink_limitnumber
With link clicks on, how many links to list, 1 to 100. SendFox's default is 50.From 1 to 100.

Outputs

campaign_idnumber
The campaign
statsobject
The campaign's stats
Example output
{
  "campaign_id": 6001,
  "stats": {
    "bounce_count": 0,
    "bounce_rate": 0,
    "click_rate": 3.4,
    "open_rate": 41.6,
    "sent_count": 238,
    "spam_count": 0,
    "spam_rate": 0,
    "unique_click_count": 8,
    "unique_open_count": 99,
    "unsubscribe_count": 1,
    "unsubscribe_rate": 0.4
  }
}

Get form

Get one sign-up form with its public link, redirect, GDPR setting and lists.

Inputs

Formform_idtextRequired
The sign-up form. Pick one, or give its id from an earlier step.

Outputs

formobject
The form
Example output
{
  "form": {
    "created_at": "2026-10-01T09:00:00Z",
    "gdpr_required": false,
    "id": 9001,
    "landing_page_id": null,
    "lists": [],
    "redirect_url": null,
    "title": "Newsletter sign-up",
    "updated_at": "2026-10-01T09:00:00Z",
    "url": "https://sendfox.com/lp/abc123"
  }
}

Get list

Get one list with its subscribed and unsubscribed counts and average open and click rates.

Inputs

Listlist_idtextRequired
The list. Pick one, or give its id from an earlier step.

Outputs

listobject
The list
Example output
{
  "list": {
    "average_email_click_percent": 3.2,
    "average_email_open_percent": 41.5,
    "created_at": "2026-10-01T09:00:00Z",
    "id": 2001,
    "name": "Newsletter",
    "public_description": null,
    "subscribed_contacts_count": 238,
    "unsubscribed_contacts_count": 2,
    "updated_at": "2026-10-01T09:00:00Z",
    "user_id": 1001
  }
}

Get stats for several campaigns

Get sends, opens, clicks, unsubscribes, bounces and spam reports for up to 100 campaigns at once, in the order given.

Inputs

Campaignscampaign_idslistRequired
Up to 100 campaigns. One that is deleted fails the whole step.

Outputs

countnumber
How many campaigns
statslist
Each campaign's stats, with its id
Example output
{
  "count": 1,
  "stats": [
    {
      "bounce_count": 0,
      "bounce_rate": 0,
      "click_rate": 3.4,
      "id": 6001,
      "open_rate": 41.6,
      "sent_count": 238,
      "spam_count": 0,
      "spam_rate": 0,
      "unique_click_count": 8,
      "unique_open_count": 99,
      "unsubscribe_count": 1,
      "unsubscribe_rate": 0.4
    }
  ]
}

Get transactional email

Get a transactional email's status, recipients and delivery events (sent, delivered, bounced and so on). Bodies are not returned.

Inputs

Message IDemail_idtextRequired
The id from 'Send transactional email', such as tm_4f0c....

Outputs

emailobject
The message
Example output
{
  "email": {
    "accepted_at": "2026-10-01T09:00:00Z",
    "attachments": [],
    "bcc": [],
    "cc": [],
    "created_at": "2026-10-01T09:00:00Z",
    "delivered_at": "2026-10-01T09:00:03Z",
    "events": [
      {
        "event": "delivered",
        "occurred_at": "2026-10-01T09:00:03Z",
        "reason": null,
        "status": "250 OK"
      }
    ],
    "failed_at": null,
    "failure": null,
    "from": "Acme <hello@mail.acme.com>",
    "headers": {},
    "id": "tm_4f0c9b2e7d1a5c3e8b6f2a9d",
    "idempotency_key": "order-1234",
    "mode": "live",
    "reply_to": null,
    "sent_at": "2026-10-01T09:00:01Z",
    "status": "delivered",
    "subject": "Your receipt",
    "tag": "receipt",
    "to": [
      "sam@example.com"
    ]
  }
}

List automations

List your automations with whether each is on, what starts it, and the emails it sends.

Inputs

Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

automationslist
The automations
countnumber
How many on this page
current_pagenumber
This page's number
has_moretrue/false
True when there is a next page
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
totalnumber
How many there are in all
Example output
{
  "automations": [
    {
      "active": true,
      "automation_items": [],
      "automation_triggers": [
        {
          "automation_id": 8001,
          "campaign_id": null,
          "contact_tag_id": null,
          "created_at": "2026-10-01T09:00:00Z",
          "id": 8101,
          "list_id": 2001,
          "type": "apply_list",
          "updated_at": "2026-10-01T09:00:00Z"
        }
      ],
      "created_at": "2026-10-01T09:00:00Z",
      "id": 8001,
      "title": "Welcome series",
      "updated_at": "2026-10-01T09:00:00Z",
      "user_id": 1001
    }
  ],
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "next_page": null,
  "per_page": 20,
  "total": 1
}

List campaigns

List your campaigns, 100 a page, with subject, sender, HTML and when each was scheduled or sent.

Inputs

Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

campaignslist
The campaigns
countnumber
How many on this page
current_pagenumber
This page's number
has_moretrue/false
True when there is a next page
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
totalnumber
How many there are in all
Example output
{
  "campaigns": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "from_email": "jo@example.com",
      "from_name": "Jo Bloggs",
      "html": "<p>Hello</p>",
      "id": 6001,
      "is_web_gated": false,
      "preview_text": null,
      "scheduled_at": null,
      "sent_at": "2026-10-02T09:00:00Z",
      "subject": "What's new in October",
      "timezone": "UTC",
      "title": "October news",
      "updated_at": "2026-10-01T09:00:00Z"
    }
  ],
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "next_page": null,
  "per_page": 20,
  "total": 1
}

List contact fields

List your custom contact fields with their labels, the names used to set them, and their types (text, number or date).

Inputs

Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

countnumber
How many on this page
current_pagenumber
This page's number
fieldslist
The contact fields
has_moretrue/false
True when there is a next page
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "fields": [
    {
      "id": 4001,
      "label": "Company",
      "name": "company",
      "type": "text"
    }
  ],
  "has_more": false,
  "next_page": null,
  "per_page": 20,
  "total": 1
}

List contact tags

List your contact tags, newest first, with how many contacts each has.

Inputs

Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

countnumber
How many on this page
current_pagenumber
This page's number
has_moretrue/false
True when there is a next page
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
tagslist
The contact tags
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "next_page": null,
  "per_page": 20,
  "tags": [
    {
      "color": "#2f80ed",
      "contacts_count": 12,
      "created_at": "2026-10-01T09:00:00Z",
      "id": 3001,
      "name": "Customer",
      "updated_at": "2026-10-01T09:00:00Z",
      "user_id": 1001
    }
  ],
  "total": 1
}

List forms

List your sign-up forms with their public links, optionally filtered by title.

Inputs

Searchquerytext
Only forms whose title matches this text.
Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

countnumber
How many on this page
current_pagenumber
This page's number
formslist
The forms
has_moretrue/false
True when there is a next page
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "forms": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "gdpr_required": false,
      "id": 9001,
      "landing_page_id": null,
      "lists": [],
      "redirect_url": null,
      "title": "Newsletter sign-up",
      "updated_at": "2026-10-01T09:00:00Z",
      "url": "https://sendfox.com/lp/abc123"
    }
  ],
  "has_more": false,
  "next_page": null,
  "per_page": 20,
  "total": 1
}

List lists

List your contact lists with subscriber counts and average open and click rates, optionally filtered by name.

Inputs

Searchquerytext
Only lists whose name matches this text.
Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

countnumber
How many on this page
current_pagenumber
This page's number
has_moretrue/false
True when there is a next page
listslist
The lists
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "lists": [
    {
      "average_email_click_percent": 3.2,
      "average_email_open_percent": 41.5,
      "created_at": "2026-10-01T09:00:00Z",
      "id": 2001,
      "name": "Newsletter",
      "public_description": null,
      "subscribed_contacts_count": 238,
      "unsubscribed_contacts_count": 2,
      "updated_at": "2026-10-01T09:00:00Z",
      "user_id": 1001
    }
  ],
  "next_page": null,
  "per_page": 20,
  "total": 1
}

List saved templates

List your saved campaign templates, 20 a page, newest first, optionally filtered by name.

Inputs

Searchsearchtext
Only templates whose name matches this text.
Pagepagenumber
Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.

Outputs

countnumber
How many on this page
current_pagenumber
This page's number
has_moretrue/false
True when there is a next page
next_pagenumber
Pass as 'page' for the next page; empty on the last one
per_pagenumber
SendFox's page size
templateslist
The templates
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "current_page": 1,
  "has_more": false,
  "next_page": null,
  "per_page": 20,
  "templates": [
    {
      "campaign_layout_id": null,
      "created_at": "2026-10-01T09:00:00Z",
      "html": "<p>Hello</p>",
      "id": 7001,
      "name": "Monthly news",
      "preview_text": null,
      "subject": null,
      "updated_at": "2026-10-01T09:00:00Z"
    }
  ],
  "total": 1
}

Send transactional email

Send one email from your app, such as a receipt or login code, to up to 10 people. Needs transactional access in SendFox.

Inputs

Fromfrom_addresstextRequired
An address on a domain verified in SendFox, optionally with a name: Acme <hello@mail.acme.com>. onboarding@sendfoxmail.com works without a domain, but only reaches your own account email.
TotolistRequired
1 to 10 addresses. Every address counts as one send.
SubjectsubjecttextRequired
The subject line.
HTML bodyhtmltext
The email as HTML. Give this, a plain-text body, or both.
Plain-text bodytexttext
The email as plain text. Give this, an HTML body, or both.
Cccclist
Addresses to copy. To, Cc and Bcc together hold at most 10.
Bccbcclist
At most 2 hidden addresses.
Reply-toreply_totext
Where replies go, if not to the From address.
Tagtagtext
A label for this kind of email, such as receipt: lowercase letters, digits, dots, dashes and underscores.
Custom headersheadersobject
Extra headers such as List-Unsubscribe or X-Entity-Ref-ID.
Idempotency keyidempotency_keytext
Any unique text, such as an order id. SendFox sends one email per key, so a re-run step does not send twice. One is made if empty.

Outputs

idtext
The message id (tm_...)
idempotency_keytext
The idempotency key the email was sent with
replayedtrue/false
True when the key was used before and nothing new was sent
request_idtext
SendFox's request id
sends_remainingnumber
Sends left this month; empty when there is no cap
statustext
Its status, such as queued
Example output
{
  "id": "tm_4f0c9b2e7d1a5c3e8b6f2a9d",
  "idempotency_key": "order-1234",
  "replayed": false,
  "request_id": "req_01HX",
  "sends_remaining": 2999,
  "status": "queued"
}

Tag contact

Apply an existing tag to a contact. Applying it again changes nothing. Returns the contact's tags.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Create contact' or an earlier step.
Tagtag_idtextRequired
The contact tag. Pick one, or give its id from an earlier step.

Outputs

contact_idnumber
The contact
countnumber
How many tags the contact has
tag_idnumber
The tag applied
tagslist
The contact's tags
Example output
{
  "contact_id": 5001,
  "count": 1,
  "tag_id": 3001,
  "tags": [
    {
      "color": "#2f80ed",
      "contacts_count": 12,
      "created_at": "2026-10-01T09:00:00Z",
      "id": 3001,
      "name": "Customer",
      "updated_at": "2026-10-01T09:00:00Z",
      "user_id": 1001
    }
  ]
}

On this page