# SendFox

> 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.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/sendfox

## Actions

### Add contact to list

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

**Inputs**

- List (`list_id`, text, required): The list. Pick one, or give its id from an earlier step.
- Contact ID (`contact_id`, text, required): The contact's id, from 'Create contact' or an earlier step.

**Outputs**

- `contact` (object): The contact
- `list_id` (number): The list

**Example output**

```json
{
  "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**

- Email (`email`, text, required): The contact's email address.
- First name (`first_name`, text): The contact's first name.
- Last name (`last_name`, text): The contact's last name.
- Lists (`lists`, list): Lists to add the contact to. Each must be active.
- Custom fields (`contact_fields`, object): Values for your account's custom contact fields.
- IP address (`ip_address`, text): The IP address the contact signed up from, if you have it.

**Outputs**

- `contact` (object): The new contact

**Example output**

```json
{
  "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**

- `user` (object): The connected account

**Example output**

```json
{
  "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**

- Automation (`automation_id`, text, required): The automation. Pick one, or give its id from an earlier step.

**Outputs**

- `automation` (object): The automation

**Example output**

```json
{
  "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**

- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.

**Outputs**

- `campaign` (object): The campaign

**Example output**

```json
{
  "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**

- Campaign (`campaign_id`, text, required): The campaign. Pick one, or give its id from an earlier step.
- Include link clicks (`include_link_stats`, true/false): Also list each link in the campaign with its click count. Default: `false`.
- Most links (`link_limit`, number): With link clicks on, how many links to list, 1 to 100. SendFox's default is 50. From 1 to 100.

**Outputs**

- `campaign_id` (number): The campaign
- `stats` (object): The campaign's stats

**Example output**

```json
{
  "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**

- Form (`form_id`, text, required): The sign-up form. Pick one, or give its id from an earlier step.

**Outputs**

- `form` (object): The form

**Example output**

```json
{
  "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**

- List (`list_id`, text, required): The list. Pick one, or give its id from an earlier step.

**Outputs**

- `list` (object): The list

**Example output**

```json
{
  "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**

- Campaigns (`campaign_ids`, list, required): Up to 100 campaigns. One that is deleted fails the whole step.

**Outputs**

- `count` (number): How many campaigns
- `stats` (list): Each campaign's stats, with its id

**Example output**

```json
{
  "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 ID (`email_id`, text, required): The id from 'Send transactional email', such as tm_4f0c....

**Outputs**

- `email` (object): The message

**Example output**

```json
{
  "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**

- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `automations` (list): The automations
- `count` (number): How many on this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when there is a next page
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `campaigns` (list): The campaigns
- `count` (number): How many on this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when there is a next page
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `count` (number): How many on this page
- `current_page` (number): This page's number
- `fields` (list): The contact fields
- `has_more` (true/false): True when there is a next page
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `count` (number): How many on this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when there is a next page
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `tags` (list): The contact tags
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- Search (`query`, text): Only forms whose title matches this text.
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `count` (number): How many on this page
- `current_page` (number): This page's number
- `forms` (list): The forms
- `has_more` (true/false): True when there is a next page
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- Search (`query`, text): Only lists whose name matches this text.
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `count` (number): How many on this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when there is a next page
- `lists` (list): The lists
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- Search (`search`, text): Only templates whose name matches this text.
- Page (`page`, number): Which page to get, starting at 1. Use 'next_page' from the last one. At least 1.

**Outputs**

- `count` (number): How many on this page
- `current_page` (number): This page's number
- `has_more` (true/false): True when there is a next page
- `next_page` (number): Pass as 'page' for the next page; empty on the last one
- `per_page` (number): SendFox's page size
- `templates` (list): The templates
- `total` (number): How many there are in all

**Example output**

```json
{
  "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**

- From (`from_address`, text, required): 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.
- To (`to`, list, required): 1 to 10 addresses. Every address counts as one send.
- Subject (`subject`, text, required): The subject line.
- HTML body (`html`, text): The email as HTML. Give this, a plain-text body, or both.
- Plain-text body (`text`, text): The email as plain text. Give this, an HTML body, or both.
- Cc (`cc`, list): Addresses to copy. To, Cc and Bcc together hold at most 10.
- Bcc (`bcc`, list): At most 2 hidden addresses.
- Reply-to (`reply_to`, text): Where replies go, if not to the From address.
- Tag (`tag`, text): A label for this kind of email, such as receipt: lowercase letters, digits, dots, dashes and underscores.
- Custom headers (`headers`, object): Extra headers such as List-Unsubscribe or X-Entity-Ref-ID.
- Idempotency key (`idempotency_key`, text): 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**

- `id` (text): The message id (tm_...)
- `idempotency_key` (text): The idempotency key the email was sent with
- `replayed` (true/false): True when the key was used before and nothing new was sent
- `request_id` (text): SendFox's request id
- `sends_remaining` (number): Sends left this month; empty when there is no cap
- `status` (text): Its status, such as queued

**Example output**

```json
{
  "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 ID (`contact_id`, text, required): The contact's id, from 'Create contact' or an earlier step.
- Tag (`tag_id`, text, required): The contact tag. Pick one, or give its id from an earlier step.

**Outputs**

- `contact_id` (number): The contact
- `count` (number): How many tags the contact has
- `tag_id` (number): The tag applied
- `tags` (list): The contact's tags

**Example output**

```json
{
  "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
    }
  ]
}
```
