VBOUT

App · 25 actions

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.

Actions

ActionWhat it does
Add contactAdd a contact to an email list.
Add or update contactAdd a contact to a list, or update it if the list already has that email address.
Add tags to contactTag a contact, found by email.
Create campaignCreate an email campaign.
Create email listCreate an email list, with its sender, double opt-in and sign-up form messages if you want them.
Delete campaignDelete an email campaign.
Delete contactDelete a contact from an email list.
Delete email listDelete an email list.
Find contactFind a contact by email address, in one list or in the whole account.
Get accountGet the VBOUT account the connection belongs to: business name, contact, phone number, VBOUT name and plan.
Get campaignGet one email campaign with its subject, sender and message.
Get campaign resultsGet a campaign's opens, bounces, unsubscribes and who clicked which link.
Get contactGet one contact by id: email, status and sign-up date.
Get contact timelineGet a contact's activity: campaigns sent to them, opens, link clicks, automations and activities you logged.
Get email listGet one email list with its settings and custom fields.
List audiencesList the audiences (saved groups of contacts) campaigns can be sent to.
List campaignsList email campaigns by status or creation date, one page at a time.
List contactsList the contacts in an email list, one page at a time.
List email listsList every email list in the account with its settings.
Log activity on contactAdd a custom note to a contact's timeline, such as 'Attended webinar'.
Move contact to another listMove a contact from one email list to another.
Remove tags from contactTake tags off a contact, found by email.
Update campaignChange an email campaign's name, subject, message, sender or delivery.
Update contactChange a contact's email, status, IP address or custom fields.
Update email listChange an email list's name or settings.

Add contact

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

Inputs

Listlist_idtextRequired
The email list. Pick one, or give its id from an earlier step.
EmailemailtextRequired
The contact's email address.
Statusstatustext
Whether the contact can be emailed. Defaults to active.One of: Active, Disactive (Inactive (VBOUT calls this 'Disactive')).
IP addressip_addresstext
The contact's IP address, if you know it.
Custom fieldsfieldsobject
Values for the list's custom fields. Leave a box empty to skip it.

Outputs

contactobject
The contact
Example output
{
  "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

Listlist_idtextRequired
The email list. Pick one, or give its id from an earlier step.
EmailemailtextRequired
The contact's email address.
Statusstatustext
Whether the contact can be emailed. Leave empty to keep it as it is.One of: Active, Disactive (Inactive (VBOUT calls this 'Disactive')).
IP addressip_addresstext
The contact's IP address, if you know it.
Custom fieldsfieldsobject
Values for the list's custom fields. Leave a box empty to skip it.

Outputs

contactobject
The contact
Example output
{
  "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 emailemailtextRequired
The email address of the contact to tag.
TagstagstextRequired
One or more tags, separated by commas.

Outputs

emailtext
The contact
taggedtrue/false
Always true once tagged
tagslist
The tags added
Example output
{
  "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

NamenametextRequired
The campaign's name, for you.
SubjectsubjecttextRequired
The subject line recipients see.
MessagebodytextRequired
The email's content, as HTML or plain text.
From emailfrom_emailtextRequired
The sender address. It must be one VBOUT allows you to send from.
From namefrom_nametextRequired
The sender name recipients see.
Reply-to emailreply_totext
Where replies go. Defaults to the from email.
Send to listslist_idslist
The lists to send to. Needed to schedule or send.
Send to audiencesaudience_idslist
The audiences to send to. Needed to schedule or send if no list is chosen.
What to do with itsend_modetext
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 atscheduled_atdate and time
When to send it. Only used when 'What to do with it' is Schedule.
Campaign typecampaign_typetext
Standard or automated. Leave empty for a standard campaign.One of: standard (Standard campaign (default)), automated (Automated campaign).

Outputs

campaignobject
The campaign
send_modetext
draft, schedule or send, as chosen
Example output
{
  "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

NamenametextRequired
The list's name.
Subscription email subjectemail_subjecttext
The subject line of the email new subscribers get.
From namefrom_nametext
The sender name on the list's emails.
From emailfrom_emailtext
The sender address on the list's emails.
Reply-to emailreply_totext
Where replies to the list's emails go.
Ask new subscribers to confirmdouble_opt_intrue/false
Send a confirmation email before a subscriber is active (double opt-in).
Notify this address of new subscribersnotify_emailtext
An address to email whenever someone subscribes. Leave empty for none.
Subscription success messagesuccess_messagetext
What the sign-up form says once someone has subscribed.
Subscription error messageerror_messagetext
What the sign-up form says if the subscription fails.

Outputs

listobject
The email list
Example output
{
  "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

Campaigncampaign_idtextRequired
The email campaign. Pick one, or give its id from an earlier step.
Campaign typecampaign_typetext
Standard or automated. Leave empty for a standard campaign.One of: standard (Standard campaign (default)), automated (Automated campaign).

Outputs

campaign_idtext
The campaign deleted
deletedtrue/false
Always true once deleted
Example output
{
  "campaign_id": "889",
  "deleted": true
}

Delete contact

Delete a contact from an email list.

Inputs

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

Outputs

contact_idtext
The contact deleted
deletedtrue/false
Always true once deleted
list_idtext
The list it was deleted from
Example output
{
  "contact_id": "3",
  "deleted": true,
  "list_id": "524"
}

Delete email list

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

Inputs

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

Outputs

deletedtrue/false
Always true once deleted
list_idtext
The list deleted
Example output
{
  "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

EmailemailtextRequired
The contact's email address.
Only in listlist_idtext
Look only in this list. Leave empty to look in every list.

Outputs

contactobject
The contact
Example output
{
  "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

businessobject
The account
Example output
{
  "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

Campaigncampaign_idtextRequired
The email campaign. Pick one, or give its id from an earlier step.
Campaign typecampaign_typetext
Standard or automated. Leave empty for a standard campaign.One of: standard (Standard campaign (default)), automated (Automated campaign).

Outputs

campaignobject
The campaign
Example output
{
  "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

Campaigncampaign_idtextRequired
The email campaign. Pick one, or give its id from an earlier step.
Campaign typecampaign_typetext
Standard or automated. Leave empty for a standard campaign.One of: standard (Standard campaign (default)), automated (Automated campaign).

Outputs

campaign_idtext
The campaign
clickslist
Links clicked, with who clicked
statsobject
Opens, unopened, bounced and unsubscribed, each as 'n (x%)'
Example output
{
  "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 IDcontact_idtextRequired
The contact's id, from 'Find contact', 'List contacts' or an earlier step.

Outputs

contactobject
The contact
Example output
{
  "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 IDcontact_idtextRequired
The contact's id, from 'Find contact', 'List contacts' or an earlier step.
Also includeincludelist
Extra detail to return with the timeline.One or more of: utm (UTM details), automated (Automated messages).

Outputs

automatedlist
Automated messages, if included
contact_idtext
The contact
countnumber
How many events were returned
emailtext
The contact's email
eventslist
The timeline's events
totalnumber
How many events the timeline holds
utmlist
UTM details, if included
Example output
{
  "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

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

Outputs

listobject
The email list
Example output
{
  "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

audienceslist
The audiences
countnumber
How many audiences
Example output
{
  "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 campaignsfiltertext
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 afterfrom_datedate
Start of a date range. Needs 'Created until' too.
Created untiluntil_datedate
End of a date range. Needs 'Created on or after' too.
Page sizelimitnumber
How many to return, 1 to 100.From 1 to 100.
Page numberpagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.

Outputs

campaignslist
The campaigns
countnumber
How many records this page holds
pagenumber
The page returned
totalnumber
How many campaigns match, as VBOUT counts them
Example output
{
  "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

Listlist_idtextRequired
The email list. Pick one, or give its id from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100.From 1 to 100.
Page numberpagenumber
Which page to get, starting at 1. Defaults to the first.At least 1.

Outputs

contactslist
The contacts
countnumber
How many records this page holds
pagenumber
The page returned
totalnumber
How many contacts the list holds, as VBOUT counts them
Example output
{
  "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

countnumber
How many lists
listslist
The lists
Example output
{
  "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 IDcontact_idtextRequired
The contact's id, from 'Find contact', 'List contacts' or an earlier step.
ActivitydescriptiontextRequired
What happened.
Whenoccurred_atdate and time
When it happened, in UTC. Defaults to now.

Outputs

addedtrue/false
Always true once logged
contact_idtext
The contact
descriptiontext
The activity logged
occurred_attext
When, as YYYY-MM-DD HH:MM (UTC)
Example output
{
  "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 IDcontact_idtextRequired
The contact's id, from 'Find contact', 'List contacts' or an earlier step.
From listfrom_list_idtextRequired
The list the contact is in now.
To listto_list_idtextRequired
The list to move the contact to.

Outputs

contact_idtext
The contact moved
from_list_idtext
The list it left
movedtrue/false
Always true once moved
to_list_idtext
The list it joined
Example output
{
  "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 emailemailtextRequired
The email address of the contact.
TagstagstextRequired
One or more tags to remove, separated by commas.

Outputs

emailtext
The contact
removedtrue/false
Always true once removed
tagslist
The tags removed
Example output
{
  "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

Campaigncampaign_idtextRequired
The email campaign. Pick one, or give its id from an earlier step.
NamenametextRequired
The campaign's name. VBOUT needs it again on every change.
Subjectsubjecttext
A new value. Leave empty to keep the current one. The subject line recipients see.
Messagebodytext
A new value. Leave empty to keep the current one. The email's content, as HTML or plain text.
From emailfrom_emailtext
A new value. Leave empty to keep the current one. The sender address. It must be one VBOUT allows you to send from.
From namefrom_nametext
A new value. Leave empty to keep the current one. The sender name recipients see.
Reply-to emailreply_totext
A new value. Leave empty to keep the current one. Where replies go. Defaults to the from email.
Send to listslist_idslist
The lists to send to. Needed to schedule or send.
Send to audiencesaudience_idslist
The audiences to send to. Needed to schedule or send if no list is chosen.
What to do with itsend_modetext
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 atscheduled_atdate and time
When to send it. Only used when 'What to do with it' is Schedule.
Campaign typecampaign_typetext
Standard or automated. Leave empty for a standard campaign.One of: standard (Standard campaign (default)), automated (Automated campaign).

Outputs

campaignobject
The campaign
send_modetext
draft, schedule or send, as chosen
Example output
{
  "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 IDcontact_idtextRequired
The contact's id, from 'Find contact', 'List contacts' or an earlier step.
New emailemailtext
A new email address. Leave empty to keep it.
Statusstatustext
Whether the contact can be emailed. Leave empty to keep it as it is.One of: Active, Disactive (Inactive (VBOUT calls this 'Disactive')).
IP addressip_addresstext
The contact's IP address, if you know it.
Custom fieldsfieldsobject
New values for the contact's custom fields, keyed by the field's id (see 'Get email list').

Outputs

contactobject
The contact
Example output
{
  "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

Listlist_idtextRequired
The email list. Pick one, or give its id from an earlier step.
Namenametext
A new name for the list. Leave empty to keep it.
Subscription email subjectemail_subjecttext
The subject line of the email new subscribers get.
From namefrom_nametext
The sender name on the list's emails.
From emailfrom_emailtext
The sender address on the list's emails.
Reply-to emailreply_totext
Where replies to the list's emails go.
Ask new subscribers to confirmdouble_opt_intrue/false
Send a confirmation email before a subscriber is active (double opt-in).
Notify this address of new subscribersnotify_emailtext
An address to email whenever someone subscribes. Leave empty for none.
Subscription success messagesuccess_messagetext
What the sign-up form says once someone has subscribed.
Subscription error messageerror_messagetext
What the sign-up form says if the subscription fails.

Outputs

listobject
The email list
Example output
{
  "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!"
  }
}

On this page