# VBOUT

> Run your VBOUT email marketing: manage email lists and contacts, tag contacts and log activity on them, create and update email campaigns, and read their results.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/vbout

## Actions

### Add contact

Add a contact to an email list. Returns the new contact.

**Inputs**

- List (`list_id`, text, required): The email list. Pick one, or give its id from an earlier step.
- Email (`email`, text, required): The contact's email address.
- Status (`status`, text): Whether the contact can be emailed. Defaults to active. One of: `Active`, `Disactive` (Inactive (VBOUT calls this 'Disactive')).
- IP address (`ip_address`, text): The contact's IP address, if you know it.
- Custom fields (`fields`, object): Values for the list's custom fields. Leave a box empty to skip it.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "email": "jo@example.com",
    "id": "3",
    "registration_date": "11/03/2026 00:00",
    "status": "1"
  }
}
```

### Add or update contact

Add a contact to a list, or update it if the list already has that email address.

**Inputs**

- List (`list_id`, text, required): The email list. Pick one, or give its id from an earlier step.
- Email (`email`, text, required): The contact's email address.
- Status (`status`, text): Whether the contact can be emailed. Leave empty to keep it as it is. One of: `Active`, `Disactive` (Inactive (VBOUT calls this 'Disactive')).
- IP address (`ip_address`, text): The contact's IP address, if you know it.
- Custom fields (`fields`, object): Values for the list's custom fields. Leave a box empty to skip it.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "email": "jo@example.com",
    "id": "3",
    "registration_date": "11/03/2026 00:00",
    "status": "1"
  }
}
```

### Add tags to contact

Tag a contact, found by email. Tags that do not exist yet are created.

**Inputs**

- Contact email (`email`, text, required): The email address of the contact to tag.
- Tags (`tags`, text, required): One or more tags, separated by commas.

**Outputs**

- `email` (text): The contact
- `tagged` (true/false): Always true once tagged
- `tags` (list): The tags added

**Example output**

```json
{
  "email": "jo@example.com",
  "tagged": true,
  "tags": [
    "customer",
    "newsletter"
  ]
}
```

### Create campaign

Create an email campaign. It is saved as a draft unless you choose to schedule it or send it now, which needs a list or audience to send to.

**Inputs**

- Name (`name`, text, required): The campaign's name, for you.
- Subject (`subject`, text, required): The subject line recipients see.
- Message (`body`, text, required): The email's content, as HTML or plain text.
- From email (`from_email`, text, required): The sender address. It must be one VBOUT allows you to send from.
- From name (`from_name`, text, required): The sender name recipients see.
- Reply-to email (`reply_to`, text): Where replies go. Defaults to the from email.
- Send to lists (`list_ids`, list): The lists to send to. Needed to schedule or send.
- Send to audiences (`audience_ids`, list): The audiences to send to. Needed to schedule or send if no list is chosen.
- What to do with it (`send_mode`, text): Draft keeps it unsent in VBOUT. Schedule and Send now email the chosen lists. One of: `draft` (Save as a draft (default)), `schedule` (Schedule for the date and time below), `send` (Send now).
- Send at (`scheduled_at`, date and time): When to send it. Only used when 'What to do with it' is Schedule.
- Campaign type (`campaign_type`, text): Standard or automated. Leave empty for a standard campaign. One of: `standard` (Standard campaign (default)), `automated` (Automated campaign).

**Outputs**

- `campaign` (object): The campaign
- `send_mode` (text): draft, schedule or send, as chosen

**Example output**

```json
{
  "campaign": {
    "creation_date": "11/03/2026 16:33",
    "from_email": "hello@example.com",
    "from_name": "Example Co",
    "id": "889",
    "message": "<p>Hello</p>",
    "name": "October news",
    "replyto": "hello@example.com",
    "status": "Draft",
    "subject": "Our October news"
  },
  "send_mode": "draft"
}
```

### Create email list

Create an email list, with its sender, double opt-in and sign-up form messages if you want them. Returns the new list.

**Inputs**

- Name (`name`, text, required): The list's name.
- Subscription email subject (`email_subject`, text): The subject line of the email new subscribers get.
- From name (`from_name`, text): The sender name on the list's emails.
- From email (`from_email`, text): The sender address on the list's emails.
- Reply-to email (`reply_to`, text): Where replies to the list's emails go.
- Ask new subscribers to confirm (`double_opt_in`, true/false): Send a confirmation email before a subscriber is active (double opt-in).
- Notify this address of new subscribers (`notify_email`, text): An address to email whenever someone subscribes. Leave empty for none.
- Subscription success message (`success_message`, text): What the sign-up form says once someone has subscribed.
- Subscription error message (`error_message`, text): What the sign-up form says if the subscription fails.

**Outputs**

- `list` (object): The email list

**Example output**

```json
{
  "list": {
    "creation_date": "11/06/2026 00:00",
    "custom_fields": [
      {
        "id": "125",
        "name": "First Name"
      }
    ],
    "doubleOptin": "0",
    "email_subject": "",
    "error_message": "You have already been subscribed to this list!",
    "form_title": "Newsletter Signup",
    "from_email": "hello@example.com",
    "from_name": "Example Co",
    "id": "524",
    "name": "Newsletter subscribers",
    "notify_email": "",
    "reply_to": "hello@example.com",
    "success_message": "Your subscription is now complete!"
  }
}
```

### Delete campaign

Delete an email campaign.

**Inputs**

- Campaign (`campaign_id`, text, required): The email campaign. Pick one, or give its id from an earlier step.
- Campaign type (`campaign_type`, text): Standard or automated. Leave empty for a standard campaign. One of: `standard` (Standard campaign (default)), `automated` (Automated campaign).

**Outputs**

- `campaign_id` (text): The campaign deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "campaign_id": "889",
  "deleted": true
}
```

### Delete contact

Delete a contact from an email list.

**Inputs**

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

**Outputs**

- `contact_id` (text): The contact deleted
- `deleted` (true/false): Always true once deleted
- `list_id` (text): The list it was deleted from

**Example output**

```json
{
  "contact_id": "3",
  "deleted": true,
  "list_id": "524"
}
```

### Delete email list

Delete an email list. Its contacts are removed from VBOUT with it.

**Inputs**

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

**Outputs**

- `deleted` (true/false): Always true once deleted
- `list_id` (text): The list deleted

**Example output**

```json
{
  "deleted": true,
  "list_id": "524"
}
```

### Find contact

Find a contact by email address, in one list or in the whole account. Fails if there is none.

**Inputs**

- Email (`email`, text, required): The contact's email address.
- Only in list (`list_id`, text): Look only in this list. Leave empty to look in every list.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "email": "jo@example.com",
    "id": "3",
    "registration_date": "11/03/2026 00:00",
    "status": "1"
  }
}
```

### Get account

Get the VBOUT account the connection belongs to: business name, contact, phone number, VBOUT name and plan.

**Inputs**: None.

**Outputs**

- `business` (object): The account

**Example output**

```json
{
  "business": {
    "business_name": "Example Co",
    "contact_name": "Jo Bloggs",
    "id": "12345",
    "package": "Pro",
    "phone_number": "212-400-7133",
    "vbout_name": "example-co"
  }
}
```

### Get campaign

Get one email campaign with its subject, sender and message.

**Inputs**

- Campaign (`campaign_id`, text, required): The email campaign. Pick one, or give its id from an earlier step.
- Campaign type (`campaign_type`, text): Standard or automated. Leave empty for a standard campaign. One of: `standard` (Standard campaign (default)), `automated` (Automated campaign).

**Outputs**

- `campaign` (object): The campaign

**Example output**

```json
{
  "campaign": {
    "creation_date": "11/03/2026 16:33",
    "from_email": "hello@example.com",
    "from_name": "Example Co",
    "id": "889",
    "message": "<p>Hello</p>",
    "name": "October news",
    "replyto": "hello@example.com",
    "status": "Draft",
    "subject": "Our October news"
  }
}
```

### Get campaign results

Get a campaign's opens, bounces, unsubscribes and who clicked which link.

**Inputs**

- Campaign (`campaign_id`, text, required): The email campaign. Pick one, or give its id from an earlier step.
- Campaign type (`campaign_type`, text): Standard or automated. Leave empty for a standard campaign. One of: `standard` (Standard campaign (default)), `automated` (Automated campaign).

**Outputs**

- `campaign_id` (text): The campaign
- `clicks` (list): Links clicked, with who clicked
- `stats` (object): Opens, unopened, bounced and unsubscribed, each as 'n (x%)'

**Example output**

```json
{
  "campaign_id": "889",
  "clicks": [
    {
      "message": "",
      "url": "https://example.com"
    }
  ],
  "stats": {
    "bounced": "0 (0%)",
    "open": "1 (33.33%)",
    "unopened": "2 (66.67%)",
    "unsubscribed": "0 (0%)"
  }
}
```

### Get contact

Get one contact by id: email, status and sign-up date.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Find contact', 'List contacts' or an earlier step.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "email": "jo@example.com",
    "id": "3",
    "registration_date": "11/03/2026 00:00",
    "status": "1"
  }
}
```

### Get contact timeline

Get a contact's activity: campaigns sent to them, opens, link clicks, automations and activities you logged.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Find contact', 'List contacts' or an earlier step.
- Also include (`include`, list): Extra detail to return with the timeline. One or more of: `utm` (UTM details), `automated` (Automated messages).

**Outputs**

- `automated` (list): Automated messages, if included
- `contact_id` (text): The contact
- `count` (number): How many events were returned
- `email` (text): The contact's email
- `events` (list): The timeline's events
- `total` (number): How many events the timeline holds
- `utm` (list): UTM details, if included

**Example output**

```json
{
  "automated": [],
  "contact_id": "3",
  "count": 1,
  "email": "jo@example.com",
  "events": [
    {
      "datetime": "2026-11-03 05:40 PM",
      "details": [],
      "key": "email-campaign-sent",
      "snippet": "Message: Our October news",
      "timestamp": 1793700000
    }
  ],
  "total": 1,
  "utm": []
}
```

### Get email list

Get one email list with its settings and custom fields.

**Inputs**

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

**Outputs**

- `list` (object): The email list

**Example output**

```json
{
  "list": {
    "creation_date": "11/06/2026 00:00",
    "custom_fields": [
      {
        "id": "125",
        "name": "First Name"
      }
    ],
    "doubleOptin": "0",
    "email_subject": "",
    "error_message": "You have already been subscribed to this list!",
    "form_title": "Newsletter Signup",
    "from_email": "hello@example.com",
    "from_name": "Example Co",
    "id": "524",
    "name": "Newsletter subscribers",
    "notify_email": "",
    "reply_to": "hello@example.com",
    "success_message": "Your subscription is now complete!"
  }
}
```

### List audiences

List the audiences (saved groups of contacts) campaigns can be sent to.

**Inputs**: None.

**Outputs**

- `audiences` (list): The audiences
- `count` (number): How many audiences

**Example output**

```json
{
  "audiences": [
    {
      "id": "148",
      "name": "Hotel show attendees"
    }
  ],
  "count": 1
}
```

### List campaigns

List email campaigns by status or creation date, one page at a time. To see more, run it again with the next page number.

**Inputs**

- Which campaigns (`filter`, text): By status, or a date range. Defaults to all. One of: `all` (All campaigns (default)), `sent`, `scheduled`, `draft` (Drafts), `automation` (Automations), `date` (Created in a date range).
- Created on or after (`from_date`, date): Start of a date range. Needs 'Created until' too.
- Created until (`until_date`, date): End of a date range. Needs 'Created on or after' too.
- Page size (`limit`, number): How many to return, 1 to 100. From 1 to 100.
- Page number (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.

**Outputs**

- `campaigns` (list): The campaigns
- `count` (number): How many records this page holds
- `page` (number): The page returned
- `total` (number): How many campaigns match, as VBOUT counts them

**Example output**

```json
{
  "campaigns": [
    {
      "creation_date": "11/03/2026 16:33",
      "from_email": "hello@example.com",
      "from_name": "Example Co",
      "id": "889",
      "message": "<p>Hello</p>",
      "name": "October news",
      "replyto": "hello@example.com",
      "status": "Draft",
      "subject": "Our October news"
    }
  ],
  "count": 1,
  "page": 1,
  "total": 1
}
```

### List contacts

List the contacts in an email list, one page at a time. To see more, run it again with the next page number.

**Inputs**

- List (`list_id`, text, required): The email list. Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 100. From 1 to 100.
- Page number (`page`, number): Which page to get, starting at 1. Defaults to the first. At least 1.

**Outputs**

- `contacts` (list): The contacts
- `count` (number): How many records this page holds
- `page` (number): The page returned
- `total` (number): How many contacts the list holds, as VBOUT counts them

**Example output**

```json
{
  "contacts": [
    {
      "email": "jo@example.com",
      "id": "3",
      "registration_date": "11/03/2026 00:00",
      "status": "1"
    }
  ],
  "count": 1,
  "page": 1,
  "total": 1
}
```

### List email lists

List every email list in the account with its settings.

**Inputs**: None.

**Outputs**

- `count` (number): How many lists
- `lists` (list): The lists

**Example output**

```json
{
  "count": 1,
  "lists": [
    {
      "creation_date": "11/06/2026 00:00",
      "custom_fields": [
        {
          "id": "125",
          "name": "First Name"
        }
      ],
      "doubleOptin": "0",
      "email_subject": "",
      "error_message": "You have already been subscribed to this list!",
      "form_title": "Newsletter Signup",
      "from_email": "hello@example.com",
      "from_name": "Example Co",
      "id": "524",
      "name": "Newsletter subscribers",
      "notify_email": "",
      "reply_to": "hello@example.com",
      "success_message": "Your subscription is now complete!"
    }
  ]
}
```

### Log activity on contact

Add a custom note to a contact's timeline, such as 'Attended webinar'.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Find contact', 'List contacts' or an earlier step.
- Activity (`description`, text, required): What happened.
- When (`occurred_at`, date and time): When it happened, in UTC. Defaults to now.

**Outputs**

- `added` (true/false): Always true once logged
- `contact_id` (text): The contact
- `description` (text): The activity logged
- `occurred_at` (text): When, as YYYY-MM-DD HH:MM (UTC)

**Example output**

```json
{
  "added": true,
  "contact_id": "3",
  "description": "Attended the webinar",
  "occurred_at": "2026-11-03 17:40"
}
```

### Move contact to another list

Move a contact from one email list to another.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Find contact', 'List contacts' or an earlier step.
- From list (`from_list_id`, text, required): The list the contact is in now.
- To list (`to_list_id`, text, required): The list to move the contact to.

**Outputs**

- `contact_id` (text): The contact moved
- `from_list_id` (text): The list it left
- `moved` (true/false): Always true once moved
- `to_list_id` (text): The list it joined

**Example output**

```json
{
  "contact_id": "3",
  "from_list_id": "524",
  "moved": true,
  "to_list_id": "525"
}
```

### Remove tags from contact

Take tags off a contact, found by email.

**Inputs**

- Contact email (`email`, text, required): The email address of the contact.
- Tags (`tags`, text, required): One or more tags to remove, separated by commas.

**Outputs**

- `email` (text): The contact
- `removed` (true/false): Always true once removed
- `tags` (list): The tags removed

**Example output**

```json
{
  "email": "jo@example.com",
  "removed": true,
  "tags": [
    "newsletter"
  ]
}
```

### Update campaign

Change an email campaign's name, subject, message, sender or delivery. The subject, message and sender you leave empty stay as they are.

**Inputs**

- Campaign (`campaign_id`, text, required): The email campaign. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): The campaign's name. VBOUT needs it again on every change.
- Subject (`subject`, text): A new value. Leave empty to keep the current one. The subject line recipients see.
- Message (`body`, text): A new value. Leave empty to keep the current one. The email's content, as HTML or plain text.
- From email (`from_email`, text): A new value. Leave empty to keep the current one. The sender address. It must be one VBOUT allows you to send from.
- From name (`from_name`, text): A new value. Leave empty to keep the current one. The sender name recipients see.
- Reply-to email (`reply_to`, text): A new value. Leave empty to keep the current one. Where replies go. Defaults to the from email.
- Send to lists (`list_ids`, list): The lists to send to. Needed to schedule or send.
- Send to audiences (`audience_ids`, list): The audiences to send to. Needed to schedule or send if no list is chosen.
- What to do with it (`send_mode`, text): Draft keeps it unsent in VBOUT. Schedule and Send now email the chosen lists. One of: `draft` (Save as a draft (default)), `schedule` (Schedule for the date and time below), `send` (Send now).
- Send at (`scheduled_at`, date and time): When to send it. Only used when 'What to do with it' is Schedule.
- Campaign type (`campaign_type`, text): Standard or automated. Leave empty for a standard campaign. One of: `standard` (Standard campaign (default)), `automated` (Automated campaign).

**Outputs**

- `campaign` (object): The campaign
- `send_mode` (text): draft, schedule or send, as chosen

**Example output**

```json
{
  "campaign": {
    "creation_date": "11/03/2026 16:33",
    "from_email": "hello@example.com",
    "from_name": "Example Co",
    "id": "889",
    "message": "<p>Hello</p>",
    "name": "October news",
    "replyto": "hello@example.com",
    "status": "Draft",
    "subject": "Our November news"
  },
  "send_mode": "draft"
}
```

### Update contact

Change a contact's email, status, IP address or custom fields.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'Find contact', 'List contacts' or an earlier step.
- New email (`email`, text): A new email address. Leave empty to keep it.
- Status (`status`, text): Whether the contact can be emailed. Leave empty to keep it as it is. One of: `Active`, `Disactive` (Inactive (VBOUT calls this 'Disactive')).
- IP address (`ip_address`, text): The contact's IP address, if you know it.
- Custom fields (`fields`, object): New values for the contact's custom fields, keyed by the field's id (see 'Get email list').

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "contact": {
    "email": "jo@example.com",
    "id": "3",
    "registration_date": "11/03/2026 00:00",
    "status": "0"
  }
}
```

### Update email list

Change an email list's name or settings. Only what you give changes.

**Inputs**

- List (`list_id`, text, required): The email list. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name for the list. Leave empty to keep it.
- Subscription email subject (`email_subject`, text): The subject line of the email new subscribers get.
- From name (`from_name`, text): The sender name on the list's emails.
- From email (`from_email`, text): The sender address on the list's emails.
- Reply-to email (`reply_to`, text): Where replies to the list's emails go.
- Ask new subscribers to confirm (`double_opt_in`, true/false): Send a confirmation email before a subscriber is active (double opt-in).
- Notify this address of new subscribers (`notify_email`, text): An address to email whenever someone subscribes. Leave empty for none.
- Subscription success message (`success_message`, text): What the sign-up form says once someone has subscribed.
- Subscription error message (`error_message`, text): What the sign-up form says if the subscription fails.

**Outputs**

- `list` (object): The email list

**Example output**

```json
{
  "list": {
    "creation_date": "11/06/2026 00:00",
    "custom_fields": [
      {
        "id": "125",
        "name": "First Name"
      }
    ],
    "doubleOptin": "0",
    "email_subject": "",
    "error_message": "You have already been subscribed to this list!",
    "form_title": "Newsletter Signup",
    "from_email": "hello@example.com",
    "from_name": "Example Co",
    "id": "524",
    "name": "Renamed list",
    "notify_email": "",
    "reply_to": "hello@example.com",
    "success_message": "Your subscription is now complete!"
  }
}
```
