Vbout API provides programmatic access to read and write Vbout data. You can use it to synch user information between your own database and Vbout's marketing automation, get prospects information and more. The responses are available in JSON/XML.
https://api.vbout.com/1/app/me
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/ApplicationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ApplicationWS($user_key); $results = $app->getBusinessInfo(); print_r($results); ?>GET https://api.vbout.com/1/app/me.json?key={YOUR_API_ID}
{ "business": { "businessName": "Loft Hotels", "contactName": "Paul Downy", "phoneNumber": "212-400-7133", "vboutName": "Loft-corporate", "package": "Franchise" } }
https://api.vbout.com/1/reputation/direct
Response formats | JSON/XML |
Requires authentication? | Yes |
filter optional |
The timeline which the reviews are returned.
Possible Values: today | lastweek | lastmonth | date |
from optional |
The from date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
to optional |
The to date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
<PHP require_once('../PATH/TO/services/ReputationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ReputationWS($user_key); $parms = array( 'filter' => 'today', ); $results = $app->getDirectReviews($parms); print_r($results); ?>GET https://api.vbout.com/1/reputation/direct.json?filter=date&from=2013-01-01&to=2014-01-01&api_key={YOUR_API_ID}
{ "reviews": { "count": 5, "items": [ { "id": "163", "email": "richi.rich@gmail.com", "phone": "917-400-7121", "date": "12/31/2013", "time": "19:00 PM", "inquiry": "This was the best meal i ever had. New management is doing a great job, keep it up!", "notes": "Jane sent him a bday coupon.", "rating": "Good" }, { "id": "182", "email": "info@vbout.com", "phone": "", "date": "12/31/2013", "time": "19:00 PM", "inquiry": "I loved the front entrance, the decore was great!", "notes": "", "rating": "Good" }, { "id": "183", "email": "dan@lasersharp.com", "phone": "", "date": "12/31/2013", "time": "19:00 PM", "inquiry": "the food was horrible!", "notes": "Contacted the customer but never heard back", "rating": "Bad" }, { "id": "184", "email": "rich@vbout.com", "phone": "", "date": "12/31/2013", "time": "19:00 PM", "inquiry": "thank you for the great experience", "notes": "came through a facebook ad", "rating": "Good" }, { "id": "202", "email": "imad@yopmail.com", "phone": "", "date": "12/31/2013", "time": "19:00 PM", "inquiry": "Server was soso but food was exceptional.", "notes": "followed up with servers on shift that night and gave them a warning.", "rating": "Good" } ] } }
https://api.vbout.com/1/reputation/online
Response formats | JSON/XML |
Requires authentication? | Yes |
channels optional |
The channels from which the reviews are gathered.
Possible Values: all | yelp | tripadvisor | citysearch | foursquare | googleplaces | zagat | menupage | opentable |
<PHP require_once('../PATH/TO/services/ReputationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ReputationWS($user_key); $parms = array( 'channels' => 'all', ); $results = $app->getOnlineReviews($parms); print_r($results); ?>GET https://api.vbout.com/1/reputation/online.json?channels=citysearch,googleplaces,zagat&api_key={YOUR_API_ID}
{ "reviews": { "count": 2, "items": { "CitySearch": { "AvgRating": "0" }, "GooglePlaces": { "AvgRating": null, "data": [ { "username": "Reina Martinez", "date": "1371004538", "inquiry": "", "rating": "a:1:{i:0;a:2:{s:6:\"rating\";i:0;s:4:\"type\";s:7:\"quality\";}}", "sourceUrl": "https://plus.google.com/100567111539474362108/about?hl=en" }, { "username": "Andrea Tassone", "date": "1394025796", "inquiry": "Not so good", "rating": "a:1:{i:0;a:2:{s:6:\"rating\";i:0;s:4:\"type\";s:7:\"quality\";}}", "sourceUrl": "https://plus.google.com/100567111539474362108/about?hl=en" } ] }, "Zagat": { "AvgRating": "0" } } } }
https://api.vbout.com/1/reputation/getfeedback
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The numerical ID of the review.
Possible Values:(ID) |
<PHP require_once('../PATH/TO/services/ReputationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ReputationWS($user_key); $id = '23'; $results = $app->getMyFeedback($id); print_r($results); ?>GET https://api.vbout.com/1/reputation/getfeedback.json?id=163&api_key={YOUR_API_ID}
{ "item": [ { "id": "163", "email": "info@siteforbiz.com", "phone": "845-990-8909", "date": "12/31/2014", "time": "19:00 PM", "inquiry": "Best chicken parm even made by men :)", "notes": "", "rating": "Good" } ] }
https://api.vbout.com/1/reputation/deletefeedback
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The numerical ID of the review you wish to delete.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/ReputationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ReputationWS($user_key); $id = '1'; $results = $app->removeFeedback($id); print_r($results); ?>GET https://api.vbout.com/1/reputation/deletefeedback.json?api_key={YOUR_API_ID}
https://api.vbout.com/1/reputation/sentiment
Response formats | JSON/XML |
Requires authentication? | Yes |
filter optional |
The type of sentiments returned.
Possible Values: all | positive | negative | neutral |
channels optional |
The channel from which the sentiments are gathered.
Possible Values: all | yelp | tripadvisor | citysearch | foursquare | googleplaces | zagat | menupage | opentable |
from optional |
The from date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
to optional |
The to date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
<PHP require_once('../PATH/TO/services/ReputationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ReputationWS($user_key); $parms = array( 'filter' => 'all', ); $results = $app->getSentiments($parms); print_r($results); ?>GET https://api.vbout.com/1/reputation/sentiment.json?filter=positive%2Cnegative&channels=facebook&api_key={YOUR_API_ID}
{ "sentiment": { "overall": { "stats": { "positives": 6, "negatives": 2 } }, "items": { "Positives": [ { "inquiry": "Great customer service!", "social": "Facebook", "reviewdate": "03/10/2014" }, { "inquiry": " love the whole experience", "social": "Facebook", "reviewdate": "03/10/2014" }, { "inquiry": " great ", "social": " Facebook ", "reviewdate": "03/10/2014" }, { "inquiry": " delicious site", "social": "Facebook", "reviewdate": "03/10/2014" }, { "inquiry": " love ", "social": "Facebook", "reviewdate": "03/10/2014" }, { "inquiry": " great ", "social": "Facebook", "reviewdate": "03/10/2014" } ], "Negatives": [ { "inquiry": " hate this place", "social": "Facebook", "reviewdate": "03/10/2014" }, { "inquiry": " waiter made us wait for a long time, did not enjoy it", "social": "Facebook", "reviewdate": "03/10/2014" } ] } } }
https://api.vbout.com/1/reputation/stats
Response formats | JSON/XML |
Requires authentication? | Yes |
filter optional |
The type of stats to return.
Possible Values: all | reviews | socialmedia | feedbackhub |
from required |
The from date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
to required |
The to date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
<PHP require_once('../PATH/TO/services/ReputationWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new ReputationWS($user_key); $parms = array( 'filter' => 'all', ); $results = $app->getStats($parms); print_r($results); ?>GET https://api.vbout.com/1/reputation/stats.json?channels=all&from=2013-01-01&to=2013-10-01&api_key={YOUR_API_ID}
{ "stats": { "items": [], "Reviews": [ { "periode": "2013-01-01", "good": "0", "bad": "0" }, { "periode": "2013-01-02", "good": "5", "bad": "2" }, { "periode": "2013-01-03", "good": "9", "bad": "1" }, .... ], "SocialMedia": [ { "periode": "2013-01-01", "twitter": 0, "facebook": 1, "yelp": 0, "foursquare": 0, "googleplus": 0, "pinterest": 0 }, { "periode": "2013-01-02", "twitter": 4, "facebook": 0, "yelp": 3, "foursquare": 0, "googleplus": 2, "pinterest": 0 }, { "periode": "2013-01-03", "twitter": 1, "facebook": 0, "yelp": 1, "foursquare": 4, "googleplus": 0, "pinterest": 0 }, { "periode": "2013-01-04", "twitter": 0, "facebook": 1, "yelp": 2, "foursquare": 4, "googleplus": 2, "pinterest": 2 }, .... ], "FeedbackHub": [ { "periode": "2013-01-01", "views": "4" }, { "periode": "2013-01-02", "views": "1" }, { "periode": "2013-01-03", "views": "8" }, { "periode": "2013-01-04", "views": "11" }, { "periode": "2013-01-05", "views": "2" }, { "periode": "2013-01-06", "views": "12" }, { "periode": "2013-01-07", "views": "20" }, { "periode": "2013-01-08", "views": "24" }, { "periode": "2013-01-09", "views": "0" }, { "periode": "2013-01-10", "views": "19" }, { "periode": "2013-01-11", "views": "0" }, { "periode": "2013-01-12", "views": "10" }, .... ] } }
https://api.vbout.com/1/socialmedia/channels
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/SocialMediaWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new SocialMediaWS($user_key); $results = $app->getChannels(); print_r($results); ?>GET https://api.vbout.com/1/socialmedia/channels.json?key={YOUR_API_ID}
{ "channels": { "Facebook": { "count": 1, "pages": [ { "id": "510584708978405", "name": "Spotless TV" } ] }, "Twitter": { "count": 1, "profiles": [ { "id": "333248756", "screenname": "imadrajab", "fullname": "Imad Rajab" } ] }, "Linkedin": { "count": 0, "profiles": [] } } }
https://api.vbout.com/1/socialmedia/calendar
Response formats | JSON/XML |
Requires authentication? | Yes |
channels optional |
The channels from where the posts are gathered.
Possible Values: all | facebook | twitter | linkedin |
from optional |
The from date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
to optional |
The to date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
includeposted optional |
Include already scheduled posts inside the results.
Possible Values: true | false |
limit optional |
Set your record limit number per page.
Possible Values: (Number) |
page optional |
Set which page you wanna get.
Possible Values: (Number) |
sort optional |
Record Sorting.
Possible Values: asc | desc |
<PHP require_once('../PATH/TO/services/SocialMediaWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new SocialMediaWS($user_key); $parms = array( 'channels' => 'all', 'includeposted' => 'true', ); $results = $app->getCalendar($parms); print_r($results); ?>POST https://api.vbout.com/1/socialmedia/calendar.json?api_key={YOUR_API_ID} channels=all includeposted=true
{ "calendar": { "count": 168, "items": { "2013-08-15": { "1": { "id": "2347", "message": "http://vbout.com/goto/b0 welcome my man ... how are you [delete url] http://vbout.com/goto/b2", "photo": { "thumb": "http://www.kickstarter.com/images/compass/site/facebook_thumb.jpg", "original": "http://www.kickstarter.com/images/compass/site/facebook_thumb.jpg" }, "channel": { "network": "Facebook", "type": "Page", "id": "510584708978405", "name": "Spotless TV", "date": "08/15/2013 14:52 PM" } }, ... }, "2013-08-16": { "2": { "id": "2366", "message": "test facebook headers", "channel": { "network": "Facebook", "type": "Page", "id": "510584708978405", "name": "Spotless TV", "date": "08/16/2013 13:39 PM" } }, "3": { "id": "2367", "message": "test facebook post with url http://vbout.com/goto/bz", "photo": { "thumb": "https://www.facebook.com/images/fb_icon_325x325.png", "original": "https://www.facebook.com/images/fb_icon_325x325.png" }, "channel": { "network": "Facebook", "type": "Page", "id": "510584708978405", "name": "Spotless TV", "date": "08/16/2013 13:40 PM" } }, "4": { "id": "2368", "message": "test all socials spiders http://vbout.com/goto/bA", "photo": { "thumb": "http://www.domaintools.com/images/logos/dt-logo-gear-50x50.png", "original": "http://www.domaintools.com/images/logos/dt-logo-gear-50x50.png" }, "channel": { "network": "Facebook", "type": "Page", "id": "510584708978405", "name": "Spotless TV", "date": "08/16/2013 13:49 PM" } }, ... } } } }
https://api.vbout.com/1/socialmedia/stats
Response formats | JSON/XML |
Requires authentication? | Yes |
channels optional |
The channels where the posts are gathered from.
Possible Values: all | facebook | twitter | linkedin | pinterest |
sort optional |
Record Sorting.
Possible Values: asc | desc |
<PHP require_once('../PATH/TO/services/SocialMediaWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new SocialMediaWS($user_key); $results = $app->getStats(); print_r($results); ?>GET https://api.vbout.com/1/socialmedia/stats.json?channels=facebook&api_key={YOUR_API_ID}
{ "stats": { "items": [ { "id": "2236", "shortenurl": "A4", "realurl": "http://munchies.com/index.php?route=information/contact&__vbtrk=NjkzNDowOnNvY2lhbG1lZGlhOmZhY2Vib29r&__vbtrk=MjgzNTowOnNvY2lhbG1lZGlhOnR3aXR0ZXI=", "message": "http://vbout.com/goto/A4 click here", "date": "1402401420", "tracks": 9, "clicks": { "facebook": "9" } }, { "id": "2436", "shortenurl": "Di", "realurl": "http://www.munchie.com/?__vbtrk=NzkxNjowOnNvY2lhbG1lZGlhOmZhY2Vib29r", "message": "Test leadscoring https://www.vbout.com/goto/Di", "date": "1408031400", "tracks": 8, "clicks": { "facebook": "8" } }, ... ] } }
https://api.vbout.com/1/socialmedia/getpost
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The id of the post.
Possible Values: (ID) |
channel required |
The channel where the post is created.
Possible Values: facebook | twitter | linkedin |
<PHP require_once('../PATH/TO/services/SocialMediaWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new SocialMediaWS($user_key); $parms = array( 'id' => '33', 'channel' => 'facebook', ); $results = $app->getMyPost($parms); print_r($results); ?>GET https://api.vbout.com/1/socialmedia/getpost.json?id=682&channel=facebook&api_key={YOUR_API_ID}
{ "item": { "id": "682", "title": "OSV Treats & Chews provides a big nutritional boost of phytonutrients & antioxidants from fruits & vegetables; tomatoes, spinach & carrots! http://www.clearconsciencepet.com/osv-meaty-treats/", "datetime": "05/16/2013 10:34 AM", "item": { "uid": "0" }, "type": "facebook", "image": "", "profile": "166346373390497" } }
https://api.vbout.com/1/socialmedia/addpost
Response formats | JSON/XML |
Requires authentication? | Yes |
message required |
The post message to be scheduled/sent.
Possible Values: (Text) |
photo optional |
The photo which will be attached to the post.
Possible Values: (Link) or (Uploaded Image) |
channels optional |
The channels which the post will be sent to.
Possible Values: all | facebook | twitter | linkedin |
isscheduled optional |
This flag will make the post to be scheduled for future.
Possible Values: true | false |
scheduleddate optional |
Date of the post to be scheduled.
Possible Values: (Date) |
scheduledhours optional |
Time of the post to be scheduled.
Possible Values: (Time) |
scheduledampm optional |
AMPM of the post to be scheduled.
Possible Values: AM | PM | am | pm |
trackableLinks optional |
Convert all links inside message to short urls.
Possible Values: true | false |
<PHP require_once('../PATH/TO/services/SocialMediaWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new SocialMediaWS($user_key); $parms = array( 'message' => 'Hello World', ); $results = $app->AddNewpost($parms); print_r($results); ?>POST https://api.vbout.com/1/socialmedia/addpost.json?key={YOUR_API_ID} message=Hello World
https://api.vbout.com/1/socialmedia/editpost
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
ID of the post message to be edited.
Possible Values: (ID) |
message optional |
The post message to be scheduled/sent.
Possible Values: (Text) |
photo optional |
The photo which will be attached to the post.
Possible Values: (Link) or (Uploaded Image) |
channels optional |
The channels which the post will be sent to.
Possible Values: all | facebook | twitter | linkedin |
isscheduled optional |
This flag will make the post to be scheduled for future.
Possible Values: true | false |
scheduleddate optional |
Date of the post to be scheduled.
Possible Values: (Date) |
scheduledhours optional |
Time of the post to be scheduled.
Possible Values: (Time) |
scheduledampm optional |
AMPM of the post to be scheduled.
Possible Values: AM | PM | am | pm |
trackableLinks optional |
Convert all links inside message to short urls.
Possible Values: true | false |
POST https://api.vbout.com/1/socialmedia/editpost.json?key={YOUR_API_ID} id=1 message=Hello World
https://api.vbout.com/1/socialmedia/deletepost
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
ID of the post message to be deleted.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/SocialMediaWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new SocialMediaWS($user_key); $id = '1'; $results = $app->removePost($id); print_r($results); ?>POST https://api.vbout.com/1/socialmedia/deletepost.json?key={YOUR_API_ID} id=1
https://api.vbout.com/1/emailmarketing/campaigns
Response formats | JSON/XML |
Requires authentication? | Yes |
filter optional |
The timeline during which the reviews are returned.
Possible Values: all | sent | scheduled | draft | automation |
from optional |
The from date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
to optional |
The to date which the reviews are returned. The filter must be 'date' for this parameter to work.
Possible Values: (Date) |
limit optional |
Set your record limit number per page.
Possible Values: (Number) |
page optional |
Set which page you wanna get.
Possible Values: (Number) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'filer' => 'all', 'limit' => '10', ); $results = $app->getCampaigns($parms); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/campaigns.json?api_key={YOUR_API_ID}
{ "campaigns": { "count": 1, "items": { "Draft": { "data": [ { "id": "889", "subject": "Hop Hop, Happy Fridays have never been happier ", "message": "...", "replyto": "info@mycompany.com", "from_email": "no-reply@mycompany.com", "from_name": "Rick's Club American", "creation_date": "11/04/2014 16:33" } ] } } } }
https://api.vbout.com/1/emailmarketing/getcampaign
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the campaign to return.
Possible Values: (ID) |
type required |
The type of the campaign.
Possible Values: standard | automated |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => '35', ); $results = $app->getCampaigns($parms); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getcampaign.json?id=889&type=standard&api_key={YOUR_API_ID}
{ "item": { "id": "889", "subject": "Reservations were never that easy!", "message": "...", "replyto": "no-reply@lofthotels.com", "from_email": "reservations@lofthotels.com", "from_name": "Loft Hotels", "creation_date": "11/04/2014 16:33" } }
https://api.vbout.com/1/emailmarketing/stats
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the campaign to return.
Possible Values: (ID) |
type required |
The type of the campaign.
Possible Values: standard | automated |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => '36', ); $results = $app->getStats($parms); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/stats.json?id=962&type=standard&api_key={YOUR_API_ID}
{ "campaign": { "stats": { "open": "1 (33.33%)", "unopened": "2 (66.67%)", "bounced": "0 (0%)", "unsubscribed": "11 (366.67%)" }, "clicks": [ { "url": "http://www.netalinissim.com/img/logo.jpg?1400686763", "message": "" }, { "url": "http://www.netalinissim.com", "message": "", "clickers": [ "imadrajab@gmail.com(2 clicks)" ] } ] } }
https://api.vbout.com/1/emailmarketing/addcampaign
Response formats | JSON/XML |
Requires authentication? | Yes |
name required |
The name of the campaign.
Possible Values: (Text) |
subject required |
The subject line for the campaign.
Possible Values: (Text) |
fromemail optional |
The from email of the campaign.
Possible Values: (Email) |
from_name optional |
The from name of the campaign.
Possible Values: (Text) |
reply_to optional |
The reply to email of the campaign.
Possible Values: (Email) |
isscheduled optional |
The flag to schedule the campaign for the future.
Possible Values: true | false |
isdraft optional |
The flag to set the campaign to draft.
Possible Values: true | false |
scheduled_datetime optional |
The date and time to schedule the campaign.
Possible Values: (Date) |
audiences optional |
IDs of audience campaign recipients.(comma separated)
Possible Values: (IDs) |
lists optional |
IDs of list campaign recipients.(comma separated)
Possible Values: (IDs) |
body required |
Message body.
Possible Values: (Text) |
type required |
The type of the campaign.
Possible Values: standard | automated |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'name' => 'Test Campaign', 'subject' => 'Hello World', 'fromemail' => 'info@example.com', 'body' => 'Message body', 'type' => 'standard', 'isdraft' => 'true', ); $results = $app->addNewCampaign($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/addcampaign.json?key={YOUR_API_ID} name=Test Campaign subject=Hello World fromemail=info@example.com body=Message body type=standard isdraft=true
https://api.vbout.com/1/emailmarketing/editcampaign
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the campaign.
Possible Values: (ID) |
name required |
The name of the campaign.
Possible Values: (Text) |
subject required |
The subject line of the campaign.
Possible Values: (Text) |
fromemail optional |
The from email of the campaign.
Possible Values: (Email) |
from_name optional |
The from name of the campaign.
Possible Values: (Text) |
reply_to optional |
The reply to email of the campaign.
Possible Values: (Email) |
isscheduled optional |
The flag to schedule the campaign for the future.
Possible Values: true | false |
isdraft optional |
The flag to set the campaign to draft.
Possible Values: true | false |
scheduled_datetime optional |
The date time to schedule the campaign.
Date format accepted: m/d/Y | Y-m-d |
audiences optional |
IDs of audience campaign recipients.(comma separated)
Possible Values: (IDs) |
lists optional |
IDs of list campaign recipients.(comma separated)
Possible Values: (IDs) |
body required |
Message body.
Possible Values: (Text) |
type required |
The type of the campaign.
Possible Values: standard | automated |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'name' => 'Test Campaign', 'subject' => 'Hello World', 'fromemail' => 'info@example.com', 'body' => 'Here the content of your message', 'type' => 'standard', ); $results = $app->updateCampaign($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/editcampaign.json?key={YOUR_API_ID} name=Test Campaign subject=Hello World fromemail=info@example.com body=Here the content of your message type=standard
https://api.vbout.com/1/emailmarketing/deletecampaign
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the campaign to delete.
Possible Values: (ID) |
type required |
The type of the campaign.
Possible Values: standard | automated |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => '886', 'type' => 'standard', ); $results = $app->removeCampaign($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/deletecampaign.json?key={YOUR_API_ID} id=886 type=standard
https://api.vbout.com/1/emailmarketing/getcontacts
Response formats | JSON/XML |
Requires authentication? | Yes |
listid required |
The ID of the list to return its contacts.
Possible Values: (IDs) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $listid = '37'; $results = $app->getMyContacts($listid); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getcontacts.json?listid=524&key={YOUR_API_ID}
{ "contacts": { "count": 15, "items": [ { "id": "3", "email": "jim@tester.com", "status": "1", "registration_date": "11/30/2014 00:00" }, { "id": "4", "email": "joe@tester.com", "status": "1", "registration_date": "11/30/2014 00:00" }, { "id": "62", "email": "jim@tester222.com", "status": "1", "registration_date": "11/30/2014 00:00" }, ... ] } }
https://api.vbout.com/1/emailmarketing/getcontactbyemail
Response formats | JSON/XML |
Requires authentication? | Yes |
email required |
The Email of the contact to return.
Possible Values: (Email) |
listid optional |
The List id of which this contact does belong to.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $email = 'info@example.com'; $listid = '39'; $results = $app->searchContact($email, $listid); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getcontactbyemail.json?email=info@example.com&key={YOUR_API_ID}
{ contact": { "id": "3", "email": "jim@tester.com", "status": "1", "registration_date": "11/30/1998 00:00" } }
https://api.vbout.com/1/emailmarketing/getcontact
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the contact to return.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $id = '3'; $results = $app->getMyContact($id); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getcontact.json?id=3&key={YOUR_API_ID}
{ contact": { "id": "3", "email": "jim@tester.com", "status": "1", "registration_date": "11/30/1998 00:00" } }
https://api.vbout.com/1/emailmarketing/addcontact
Response formats | JSON/XML |
Requires authentication? | Yes |
email required |
The email of the contact.
Possible Values: (Email) |
ipaddress (optional) |
The ip of the contact.
Possible Values: (IP) |
status required |
The status of the contact.
Possible Values: (Active | Disactive) |
listid required |
The ID of the list to assign this contact to.
Possible Values: (ID) |
fields (optional) |
The list of custom fields added to a specific list.
Possible Values: Array('fieldID'=>'fieldValue') |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'email' => 'info@example.com', 'status' => 'active', 'listid' => '24,25,12', 'fields' => array('125' => 'John','1204' => 'Doe','325' => '1983-9-1',), ); $results = $app->addNewContact($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/addcontact.json?key={YOUR_API_ID} email=info@example.com status=active listid=24,25,12 fields[125]=John fields[1204]=Doe fields[325]=1983-9-1
https://api.vbout.com/1/emailmarketing/editcontact
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the contact.
Possible Values: (ID) |
email (optional) |
The email of the contact.
Possible Values: (Email) |
ipaddress (optional) |
The ip of the contact.
Possible Values: (IP) |
status (optional) |
The status of the contact.
Possible Values: (Active | Disactive) |
fields (optional) |
The list of custom fields added to a specific list.
Possible Values: Array('fieldID'=>'fieldValue') |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => '1', 'email' => 'info@example.com', 'status' => 'active', 'listid' => '24', 'fields' => array('125' => 'John','1204' => 'Doe','325' => '1983-9-1',), ); $results = $app->updateContact($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/editcontact.json?key={YOUR_API_ID} id=1 email=info@example.com status=active listid=24 fields[125]=John fields[1204]=Doe fields[325]=1983-9-1
https://api.vbout.com/1/emailmarketing/synccontact
Response formats | JSON/XML |
Requires authentication? | Yes |
Note | All emails having the same email text available in the provided list will be updated if exists (case email is not required). |
email required |
The email of the contact.
Possible Values: (Email) |
ipaddress (optional) |
The ip of the contact.
Possible Values: (IP) |
status required |
The status of the contact.
Possible Values: (Active | Disactive) |
listid required |
The ID of the list to assign this contact to.
Possible Values: (ID) |
fields (optional) |
The list of custom fields added to a specific list.
Possible Values: Array('fieldID'=>'fieldValue') |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'email' => 'info@example.com', 'status' => 'active', 'listid' => '24,25,12', 'fields' => array('125' => 'John','1204' => 'Doe','325' => '1983-9-1',), ); $results = $app->syncContactMethod($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/synccontact.json?key={YOUR_API_ID} email=info@example.com status=active listid=24,25,12 fields[125]=John fields[1204]=Doe fields[325]=1983-9-1
https://api.vbout.com/1/emailmarketing/movecontact
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the contact.
Possible Values: (ID) |
listid required |
The ID of the list to assign this contact to.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => '1', 'listid' => '24', ); $results = $app->moveContact($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/movecontact.json?key={YOUR_API_ID} id=1 listid=24
https://api.vbout.com/1/emailmarketing/deletecontact
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the contact to delete.
Possible Values: (ID) |
listid required |
The ID of the list to delete from.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $id = '14523'; $listid = '45678'; $results = $app->removeContact($id, $listid); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/deletecontact.json?key={YOUR_API_ID} id=14523 listid=45678
https://api.vbout.com/1/emailmarketing/getlists
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $results = $app->getMyLists(); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getlists.json?key={YOUR_API_ID}
{ "lists": { "count": 41, "items": [ { "id": "148", "name": "2014 NYC hotel show", "form_title": "2014 NYC hotel show", "email_subject": "", "reply_to": "", "from_email": "", "from_name": "", "confimation_email": "\r\n\r\n\r\n\r\n\r\nPlease click on the link below to confirm your subscription.
\r\n\r\n", "success_email": "\r\n\r\n\r\n\r\n\r\n
[CONFIRMATION_URL]
[BUSINESS_NAME]
[ADDRESS]Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
\r\n\r\n", "confimation_message": "\r\n\r\n\r\n\r\n\r\n
[BUSINESS_NAME]
[ADDRESS]Your signup is almost complete! Please check your email for a confirmation message.
\r\n\r\n", "success_message": "\r\n\r\n\r\n\r\n\r\nYour subscription is now complete!
\r\n\r\n", "error_message": "\r\n\r\n\r\n\r\n\r\n\r\n\r\n", "doubleOptin": "0", "notify_email": "imadrajab@gmail.com", "creation_date": "04/10/2014 00:00" }, { "id": "157", "name": "Startup Alley NYC", "form_title": "Untitled Form", "email_subject": "", "reply_to": "", "from_email": "", "from_name": "", "confimation_email": "Please click on the link below to confirm your subscription.
[CONFIRMATION_URL]
[BUSINESS_NAME]
[ADDRESS]", "success_email": "Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
[BUSINESS_NAME]
[ADDRESS]", "confimation_message": "Your signup is almost complete! Please check your email for a confirmation message.", "success_message": "Your subscription is now complete!", "error_message": "You have already been subscribed to this list!", "doubleOptin": "0", "notify_email": "", "creation_date": "04/15/2014 00:00" }, { "id": "180", "name": "My Autoresponder List", "form_title": "Untitled Form", "email_subject": "", "reply_to": "", "from_email": "", "from_name": "", "confimation_email": "Please click on the link below to confirm your subscription.
[CONFIRMATION_URL]
[BUSINESS_NAME]
[ADDRESS]", "success_email": "Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
[BUSINESS_NAME]
[ADDRESS]", "confimation_message": "Your signup is almost complete! Please check your email for a confirmation message.", "success_message": "Your subscription is now complete!", "error_message": "", "doubleOptin": "0", "notify_email": "", "creation_date": "04/22/2014 00:00" }, { "id": "480", "name": "Content Automation Center Funnel", "form_title": "testing automation", "email_subject": "Subscription to testing automation", "reply_to": "no-reply@vbout.com", "from_email": "imadrajab@gmail.com", "from_name": "Vbout", "confimation_email": "\r\n\r\n\r\n\r\n\r\nPlease click on the link below to confirm your subscription.
\r\n\r\n", "success_email": "\r\n\r\n\r\n\r\n\r\n
[CONFIRMATION_URL]
[BUSINESS_NAME]Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
\r\n\r\n", "confimation_message": "\r\n\r\n\r\n\r\n\r\n
[BUSINESS_NAME]Your signup is almost complete! Please check your email for a confirmation message.
\r\n\r\n", "success_message": "\r\n\r\n\r\n\r\n\r\nYour subscription is now complete!
\r\n\r\n", "error_message": "\r\n\r\n\r\n\r\n\r\nYou have already been subscribed to this list!
\r\n\r\n", "doubleOptin": "0", "notify_email": "imadrajab@gmail.com", "creation_date": "09/29/2014 00:00" }, { "id": "481", "name": "Content Automation Bottom Funnel", "form_title": "testing automation", "email_subject": "", "reply_to": "", "from_email": "", "from_name": "", "confimation_email": "Please click on the link below to confirm your subscription.
[CONFIRMATION_URL]
[BUSINESS_NAME]", "success_email": "Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
[BUSINESS_NAME]", "confimation_message": "Your signup is almost complete! Please check your email for a confirmation message.", "success_message": "Your subscription is now complete!", "error_message": "You have already been subscribed to this list!", "doubleOptin": "0", "notify_email": "", "creation_date": "09/30/2014 00:00" }, { "id": "482", "name": "Birthday List", "form_title": "testing automation", "email_subject": "", "reply_to": "", "from_email": "", "from_name": "", "confimation_email": "\r\n\r\n\r\n\r\n\r\nPlease click on the link below to confirm your subscription.
\r\n\r\n", "success_email": "\r\n\r\n\r\n\r\n\r\n
[CONFIRMATION_URL]
[BUSINESS_NAME]Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
\r\n\r\n", "confimation_message": "\r\n\r\n\r\n\r\n\r\n
[BUSINESS_NAME]Your signup is almost complete! Please check your email for a confirmation message.
\r\n\r\n", "success_message": "\r\n\r\n\r\n\r\n\r\nYour subscription is now complete!
\r\n\r\n", "error_message": "\r\n\r\n\r\n\r\n\r\nYou have already been subscribed to this list!
\r\n\r\n", "doubleOptin": "0", "notify_email": "", "creation_date": "10/01/2014 00:00" }, { "id": "524", "name": "TestYogaShopFunnelForm", "form_title": "Untitled Form", "email_subject": "", "reply_to": "", "from_email": "", "from_name": "", "confimation_email": "Please click on the link below to confirm your subscription.
[CONFIRMATION_URL]
[BUSINESS_NAME]", "success_email": "Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
[BUSINESS_NAME]", "confimation_message": "Your signup is almost complete! Please check your email for a confirmation message.", "success_message": "Your subscription is now complete!", "error_message": "You have already been subscribed to this list!", "doubleOptin": "0", "notify_email": "", "creation_date": "11/06/2014 00:00" }, ... ] } }
https://api.vbout.com/1/emailmarketing/getlist
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the list to return.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $id = '524'; $results = $app->getMyList($id); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getlist.json?id=524&key={YOUR_API_ID}
{ "list": { "id": "524", "name": "Landing page subscription form", "form_title": "Newsletter Signup", "email_subject": "", "reply_to": "", "from_email": "rich@vbout.com", "from_name": "Rich from Vbout", "confimation_email": "Please click on the link below to confirm your subscription.
[CONFIRMATION_URL]
[BUSINESS_NAME]", "success_email": "Your email is now confirmed! we are excited to have you on our list. We will be in touch soon.
[BUSINESS_NAME]", "confimation_message": "Your signup is almost complete! Please check your email for a confirmation message.", "success_message": "Your subscription is now complete!", "error_message": "You have already been subscribed to this list!", "doubleOptin": "0", "notify_email": "", "creation_date": "11/06/2014 00:00", "fields": {"125":"First Name","1204":"Last Name","325":"Date Of Birth"} } }
https://api.vbout.com/1/emailmarketing/addlist
Response formats | JSON/XML |
Requires authentication? | Yes |
name required |
The name of the list.
Possible Values: (Text) |
email_subject required |
The default subscription subject.
Possible Values: (Text) |
reply_to required |
The Reply to email of the list.
Possible Values: (Email) |
fromemail required |
The From email of the list.
Possible Values: (Email) |
from_name required |
The From name of the list.
Possible Values: (Text) |
doubleOptin required |
Email confirmation required (Double opt-in)?
Possible Values: 0 | 1 |
notify required |
Notify me of new subscribers.
Possible Values: (Text) |
notify_email required |
Notification Email.
Possible Values: (Email) |
success_email required |
Subscription Success Email.
Possible Values: (Email) |
success_message required |
Subscription Success Message.
Possible Values: (Text) |
error_message required |
Subscription Error Message.
Possible Values: (Text) |
confirmation_email optional |
Confirmation Email Message.
Possible Values: (Text) |
confirmation_message optional |
Confirmation Message.
Possible Values: (Text) |
communications optional |
Turn off Communications? (0-No | 1-Yes)
Possible Values: 0 | 1 |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'name' => 'List 1', 'email_subject' => 'Hello World', 'reply_to' => 'no-reply@example.com', 'fromemail' => 'info@example.com', 'from_name' => ' Name ', 'notify' => 'Notify me of new subscribers.', 'notify_email' => 'info@example.com', 'success_email' => 'info@example.com', 'success_message' => 'Subscription Success Message', 'error_message' => 'Subscription Error Message', ); $results = $app->addNewList($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/addlist.json?key={YOUR_API_ID} name=List 1 email_subject=Hello World reply_to=no-reply@example.com fromemail=info@example.com from_name= Name notify=Notify me of new subscribers. notify_email=info@example.com success_email=info@example.com success_message=Subscription Success Message error_message=Subscription Error Message
https://api.vbout.com/1/emailmarketing/editlist
Response formats | JSON/XML |
Requires authentication? | Yes |
name required |
The name of the list.
Possible Values: (Text) |
email_subject required |
The default subject line of subscription.
Possible Values: (Text) |
reply_to required |
The Reply to email of the list.
Possible Values: (Email) |
fromemail required |
The From email of the list.
Possible Values: (Email) |
from_name required |
The From name of the list.
Possible Values: (Text) |
doubleOptin required |
Email confirmation required (Double opt-in)?
Possible Values: 0 | 1 |
notify required |
Notify me of new subscribers.
Possible Values: (Text) |
notify_email required |
Notification Email.
Possible Values: (Email) |
success_email required |
Subscription Success Email.
Possible Values: (Text) |
success_message required |
Subscription Success Message.
Possible Values: (Text) |
error_message required |
Subscription Error Message.
Possible Values: (Text) |
confirmation_email optional |
Confirmation Email Message.
Possible Values: (Text) |
confirmation_message optional |
Confirmation Message.
Possible Values: (Text) |
communications optional |
Turn off Communications? (0-No | 1-Yes)
Possible Values: 0 | 1 |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => '1', 'name' => 'List 1', 'email_subject' => 'Hello World', 'reply_to' => 'no-reply@example.com', 'fromemail' => 'info@example.com', 'from_name' => ' Name ', 'notify' => 'Notify me of new subscribers.', 'notify_email' => 'info@example.com', 'success_email' => 'info@example.com', 'success_message' => 'Subscription Success Message', 'error_message' => 'Subscription Error Message', ); $results = $app->updateList($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/editlist.json?key={YOUR_API_ID} id=1 name=List 1 email_subject=Hello World reply_to=no-reply@example.com fromemail=info@example.com from_name= Name notify=Notify me of new subscribers. notify_email=info@example.com success_email=info@example.com success_message=Subscription Success Message error_message=Subscription Error Message
https://api.vbout.com/1/emailmarketing/deletelist
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the list to delete.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $id = '320'; $results = $app->removeList($id); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/deletelist.json?key={YOUR_API_ID} id=320
https://api.vbout.com/1/emailmarketing/getaudiences
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $results = $app->getMyAudiences(); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getaudiences.json?key={YOUR_API_ID}
{ "audiences": { "count": 41, "items": [ { "id": "148", "name": "2014 NYC hotel show", }, { "id": "157", "name": "Startup Alley NYC", }, { "id": "180", "name": "My Autoresponder Audience", }, { "id": "480", "name": "Content Automation Center Funnel", }, { "id": "481", "name": "Content Automation Bottom Funnel", }, { "id": "482", "name": "Birthday Audience", }, { "id": "524", "name": "TestYogaShopFunnelForm", }, ... ] } }
https://api.vbout.com/1/emailmarketing/addactivity
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The id of the contact.
Possible Values: (ID) |
description required |
The description of the activity.
Possible Values: (Text) |
datetime required |
The date and time to activity.
Possible Values: (DateTime) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => 'xxxxx', 'description' => 'this is my first activity', 'datetime' => '2021-04-13 15:26', ); $results = $app->addNewActivity($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/addactivity.json?key={YOUR_API_ID} id=xxxxx description=this is my first activity datetime=2021-04-13 15:26
https://api.vbout.com/1/emailmarketing/addtag
Response formats | JSON/XML |
Requires authentication? | Yes |
Note | List of tags can be sent as a batch, separated by a comma. Either email or id can be used |
id |
The id of the contact.
Possible Values: (ID) |
email |
The email of the contact.
Possible Values: (text) |
tagname required |
Tag(s) to be added.
Possible Values: (Text) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => 'xxxxx', 'tagname' => 'this is my first tag', ); $results = $app->addNewTag($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/addtag.json?key={YOUR_API_ID} id=xxxxx tagname=this is my first tag
https://api.vbout.com/1/emailmarketing/removetag
Response formats | JSON/XML |
Requires authentication? | Yes |
Note | List of tags can be sent as a batch, separated by a comma. Either email or id can be used |
id required |
The id of the contact.
Possible Values: (ID) |
email |
The email of the contact.
Possible Values: (text) |
tagname required |
Tag(s) to be added.
Possible Values: (Text) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $parms = array( 'id' => 'xxxxx', 'tagname' => 'this is my first tag', ); $results = $app->deleteTag($parms); print_r($results); ?>POST https://api.vbout.com/1/emailmarketing/removetag.json?key={YOUR_API_ID} id=xxxxx tagname=this is my first tag
https://api.vbout.com/1/emailmarketing/getcoupon
Response formats | JSON/XML |
Requires authentication? | Yes |
email required |
The email of the contact to return coupons of.
Possible Values: (EMAIL) |
campaignid required |
The ID of the campaign containing coupons.
Possible Values: (CAMPAIGN ID) |
<PHP require_once('../PATH/TO/services/EmailMarketingWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new EmailMarketingWS($user_key); $email = 'john@doe.com'; $results = $app->getCoupon($email); print_r($results); ?>GET https://api.vbout.com/1/emailmarketing/getcoupon.json?email=john@doe.com&key={YOUR_API_ID}
{ "coupons": [ { "id": "15817148", "email": "john@doe.com", "couponcode": "XXXXXXXXXXXXXX", "couponredeemed": "0", "couponredeemedon": "N/A" } ] }
https://api.vbout.com/1/user/lists
Response formats | JSON/XML |
Requires authentication? | Yes |
businessid optional |
The ID of the business if it's an agency to return its contacts.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $results = $app->getusers(); print_r($results); ?>GET https://api.vbout.com/1/user/lists.json?businessid=124&key={YOUR_API_ID}
{ "users": { "count": 2, "items": { "34": { "users": { "34": { "fullname": "Imad Rajab", "username": "imadrajab@yopmail.com" }, ... } }, "193": { "users": { "45": { "fullname": "Test", "username": "test22@yopmail.com", "group": "-", "status": "Active" }, ... } } } } }
https://api.vbout.com/1/user/managers
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $results = $app->getManagers(); print_r($results); ?>GET https://api.vbout.com/1/user/managers.json?key={YOUR_API_ID}
{ "users": { "count": 7, "items": [ { "id": "2", "fullname": "Imad Rajab", "email": "imadmasteruser@yopmail.com", "status": "Active" }, { "id": "10", "fullname": "Johnny Moubayed", "email": "johnnymoubayed@yopmail.com", "status": "Active" }, ... } }
https://api.vbout.com/1/user/status
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the user to change status.
Possible Values: (ID) |
type required |
The type of the user.
Possible Values: user | manager |
status required |
The status of the user.
Possible Values: 0 [DISABLE] | 1 [ENABLE] |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $parms = array( 'id' => '1', 'type' => 'user', 'status' => '0', ); $results = $app->changeStatus($parms); print_r($results); ?>POST https://api.vbout.com/1/user/status.json?key={YOUR_API_ID} id=1 type=user status=0
https://api.vbout.com/1/user/add
Response formats | JSON/XML |
Requires authentication? | Yes |
fullname required |
The name of the user.
Possible Values: (Text) |
username required |
The username of the user.
Possible Values: (Text) |
password required |
The password of the user.
Possible Values: (Text) |
type required |
The type of the user.
Possible Values: user | manager |
group optional |
The group id of the user.
Possible Values: (ID) |
permissions optional |
The permissions of the user. (comma-separated values)
Possible Values: reputation_center | foursquare | pinterest | social_media | email_marketing | master_reporting | users_and_workflow | smart_calendar | site_builder | asset_manager | task_manager | notes | social_tracker | collaboration | google_analytics | email_automation_workflow | live_hashtags | goal_conversion_tracking | expedia_affiliate_network | behavioral_webhooks | lead_scoring | user_groups |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $parms = array( 'fullname' => 'John Smith', 'username' => 'john@example.com', 'password' => 'user123', 'type' => 'user', ); $results = $app->addNewUser($parms); print_r($results); ?>POST https://api.vbout.com/1/user/add.json?key={YOUR_API_ID} fullname=John Smith username=john@example.com password=user123 type=user
https://api.vbout.com/1/user/edit
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the user.
Possible Values: (ID) |
fullname required |
The name of the user.
Possible Values: (Text) |
username required |
The username of the user.
Possible Values: (Text) |
password required |
The password of the user.
Possible Values: (Text) |
type required |
The type of the user.
Possible Values: user | manager |
group optional |
The group id of the user.
Possible Values: (ID) |
permissions optional |
The permissions of the user. (comma-separated values)
Possible Values: reputation_center | foursquare | pinterest | social_media | email_marketing | master_reporting | users_and_workflow | smart_calendar | site_builder | asset_manager | task_manager | notes | social_tracker | collaboration | google_analytics | email_automation_workflow | live_hashtags | goal_conversion_tracking | expedia_affiliate_network | behavioral_webhooks | lead_scoring | user_groups |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $parms = array( 'fullname' => 'John Smith', 'username' => 'john@example.com', 'password' => 'user123', 'type' => 'user', ); $results = $app->updateUser($parms); print_r($results); ?>POST https://api.vbout.com/1/user/edit.json?key={YOUR_API_ID} fullname=John Smith username=john@example.com password=user123 type=user
https://api.vbout.com/1/user/delete
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the user to delete.
Possible Values: (ID) |
type required |
The type of the user.
Possible Values: user | manager |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $parms = array( 'id' => '1', 'type' => 'user', ); $results = $app->removeUser($parms); print_r($results); ?>POST https://api.vbout.com/1/user/delete.json?key={YOUR_API_ID} id=1 type=user
https://api.vbout.com/1/user/groups
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $results = $app->getGroups(); print_r($results); ?>GET https://api.vbout.com/1/user/groups.json?key={YOUR_API_ID}
{ "groups": { "count": 3, "items": [ { "id": "4", "name": "Sales Team #Chicago", "status": "Active" }, { "id": "5", "name": "Sales Team #New York", "status": "Active" }, ... } }
https://api.vbout.com/1/user/groupdelete
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the group to delete.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $parms = array( 'id' => '1', ); $results = $app->removeGroup($parms); print_r($results); ?>POST https://api.vbout.com/1/user/groupdelete.json?key={YOUR_API_ID} id=1
https://api.vbout.com/1/user/groupstatus
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the group to change status.
Possible Values: (ID) |
status required |
The status of the group.
Possible Values: 0 [DISABLE] | 1 [ENABLE] |
<PHP require_once('../PATH/TO/services/UserWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new UserWS($user_key); $parms = array( 'id' => '1', 'status' => '0', ); $results = $app->changeGroupStatus($parms); print_r($results); ?>POST https://api.vbout.com/1/user/groupstatus.json?key={YOUR_API_ID} id=1 status=0
https://api.vbout.com/1/goal/lists
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/GoalWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new GoalWS($user_key); $results = $app->getGoals(); print_r($results); ?>GET https://api.vbout.com/1/goal/lists.json?key={YOUR_API_ID}
{ "goals": { "count": 8, "items": [ { "id": "41", "name": "Cart conversion (All Links)", "goal_value": { "type": "Fixed", "value": "80.0000" }, "type": "Event Triggered", "event_type": "Link(s) Clicked", "event_link_rule": "All of these link(s) clicked", "links": [ "http://yogashop.com/index.php?route=information/contact", "http://yogashop.com/index.php?route=blog/blog" ], ], "has_action": "Yes", "action": { "id": "69", "name": "Action is deleted!" } }, ... } }
https://api.vbout.com/1/goal/listbydomain
Response formats | JSON/XML |
Requires authentication? | Yes |
domainid required |
The ID of the domain to return its goals.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/GoalWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new GoalWS($user_key); $parms = array( 'domainid' => '41', ); $results = $app->getGoalsByDomain($parms); print_r($results); ?>GET https://api.vbout.com/1/goal/listbydomain.json?domainid=1&key={YOUR_API_ID}
{ "goals": { "count": 7, "items": [ { "id": "41", "name": "Test Goal Action (All Links)", "goal_value": { "type": "Fixed", "value": "0.0000" }, "type": "Event Triggered", "event_type": "Link(s) Clicked", "event_link_rule": "All of these link(s) clicked", "links": [ "http://yogashop.com/index.php?route=information/contact", "http://yogashop.com/index.php?route=blog/blog" ], "has_action": "Yes", "action": { "id": "69", "name": "Action is deleted!" } }, ... } }
https://api.vbout.com/1/goal/show
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the goal.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/GoalWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new GoalWS($user_key); $parms = array( 'id' => '46', ); $results = $app->getGoal($parms); print_r($results); ?>GET https://api.vbout.com/1/goal/show.json?id=41&key={YOUR_API_ID}
{ "goal": { "id": "41", "name": "Test Goal Action (All Links)", "goal_value": { "type": "Fixed", "value": "0.0000" }, "type": "Event Triggered", "event_type": "Link(s) Clicked", "event_link_rule": "All of these link(s) clicked", "links": [ "http://yogashop.com/index.php?route=information/contact", "http://yogashop.com/index.php?route=blog/blog" ], "has_action": "Yes", "action": { "id": "69", "name": "Action is deleted!" } } }
https://api.vbout.com/1/goal/add
Response formats | JSON/XML |
Requires authentication? | Yes |
domainid required |
The Domain id of the goal.
Possible Values: (ID) |
name required |
The name of the goal.
Possible Values: (Text) |
type required |
The type of the goal.
Possible Values: url | duration | pages | ppc | event |
value_type optional |
Goal Value Type.
Possible Values: fixed | variable |
value optional |
Goal Value if the value type is fixed.
Possible Values: (Number) |
destination_url optional |
The Destination URL.
Possible Values: (Link) |
duration_hours optional |
The Duration Number of Hours.
Possible Values: (Number) |
duration_minutes optional |
The Duration Number of Minutes.
Possible Values: (Number) |
duration_seconds optional |
The Duration Number of Seconds.
Possible Values: (Number) |
pages optional |
The Number of Pages.
Possible Values: (Number) |
ppc_networks optional |
The type of Referral Networks.
Possible Values: google | bing | facebook | twitter | linkedin |
event_type optional |
The type of Event.
Possible Values: links | videos | form |
goal_event_filter optional |
Goal will be met if.
Possible Values: any | all | all |
event_links optional |
The Event Links.
Possible Values: (Link) |
event_videos optional |
links of embedded video.
Possible Values: (Links) |
form_identity_type optional |
Form catch by
Possible Values: id | name |
form_identity optional |
The Form identity.
Possible Values: (Text) |
<PHP require_once('../PATH/TO/services/GoalWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new GoalWS($user_key); $parms = array( 'domainid' => '1', 'name' => 'goal Name', 'type' => 'url', ); $results = $app->addNewGoal($parms); print_r($results); ?>POST https://api.vbout.com/1/goal/add.json?key={YOUR_API_ID} domainid=1 name=goal Name type=url
https://api.vbout.com/1/goal/edit
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the goal.
Possible Values: (ID) |
name required |
The name of the goal.
Possible Values: (Text) |
type required |
The type of the goal.
Possible Values: url | duration | pages | ppc | event |
value_type optional |
Goal Value Type.
Possible Values: fixed | variable |
value optional |
Goal Value if the value type is fixed.
Possible Values: (Number) |
destination_url optional |
The Destination URL.
Possible Values: (Link) |
duration_hours optional |
The Duration Number of Hours.
Possible Values: (Number) |
duration_minutes optional |
The Duration Number of Minutes.
Possible Values: (Number) |
duration_seconds optional |
The Duration Number of Seconds.
Possible Values: (Number) |
pages optional |
The Number of Pages.
Possible Values: (Number) |
ppc_networks optional |
The type of Referral Networks.
Possible Values: google | bing | facebook | twitter | linkedin |
event_type optional |
The type of Event.
Possible Values: links | videos | form |
goal_event_filter optional |
Goal will be met if.
Possible Values: any | all | all |
event_links optional |
The Event Links.
Possible Values: (Link) |
event_videos optional |
links of embedded video.
Possible Values: (Links) |
form_identity_type optional |
Form catch by
Possible Values: id | name |
form_identity optional |
The Form identity.
Possible Values: (Text) |
<PHP require_once('../PATH/TO/services/GoalWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new GoalWS($user_key); $parms = array( 'id' => '1', 'name' => 'goal Name', 'type' => 'url', ); $results = $app->updateGoal($parms); print_r($results); ?>POST https://api.vbout.com/1/goal/edit.json?key={YOUR_API_ID} id=1 name=goal Name type=url
https://api.vbout.com/1/goal/delete
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the goal to delete.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/GoalWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new GoalWS($user_key); $parms = array( 'id' => '1', ); $results = $app->removeGoal($parms); print_r($results); ?>POST https://api.vbout.com/1/goal/delete.json?key={YOUR_API_ID} id=1
https://api.vbout.com/1/webhook/lists
Response formats | JSON/XML |
Requires authentication? | Yes |
None |
<PHP require_once('../PATH/TO/services/WebhookWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new WebhookWS($user_key); $results = $app->getWebhooks(); print_r($results); ?>GET https://api.vbout.com/1/webhook/lists.json?key={YOUR_API_ID}
{ "webhooks": { "count": 1, "items": [ { "id": "107", "name": "Doctor Request Poll!", "type": "On Page Exit", "domain_id": "1", "url": { "filter": "Matches Exactly", "link": "" }, "action_type": "HTML Message", "action_rules": { "execute_for": "All Visitors", "device_filter": "All Devices", "interval": "Repeats", "delay": { "hours": "0", "minutes": "0", "seconds": "0" } }, "action_stype": "Popup" }, ... } }
https://api.vbout.com/1/webhook/show
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the webhook.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/WebhookWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new WebhookWS($user_key); $results = $app->getWebhook(); print_r($results); ?>GET https://api.vbout.com/1/webhook/show.json?id=107&key={YOUR_API_ID}
{ "webhook": { "id": "107", "name": "Poll on who will be elected!", "type": "On Page Exit", "domain_id": "1", "url": { "filter": "Matches Exactly", "link": "" }, "action_type": "HTML Message", "action_rules": { "execute_for": "All Visitors", "device_filter": "All Devices", "interval": "Repeats", "delay": { "hours": "0", "minutes": "0", "seconds": "0" } }, "action_stype": "Popup" } }
https://api.vbout.com/1/webhook/add
Response formats | JSON/XML |
Requires authentication? | Yes |
domainid required |
The Domain id of the webhook.
Possible Values: (ID) |
name required |
The name of the webhook.
Possible Values: (Text) |
type required |
The type of the webhook.
Possible Values: page_exit | page_entry | goal_trigger |
action_url optional |
Page Url.
Possible Values: (Text) |
action_type required |
The type of the action.
Possible Values: html_msg | form | poll | redirection | trigger_js |
redirection_url optional |
Redirection URL.
Possible Values: (Link) |
list_id optional |
The List ID.
Possible Values: (ID) |
poll_question optional |
The Polling Question.
Possible Values: (Text) |
poll_choices optional |
The polling Choices.
Possible Values: (Text) |
js_code optional |
The Javascript Code.
Possible Values: (Text) |
action_startdate optional |
The Action Trigger Start Date.
Possible Values: (Date) |
action_enddate optional |
The Action Trigger End Date.
Possible Values: (Date) |
action_targetusers optional |
The Target Users.
Possible Values: all | subscribers | anonymous |
action_devicefilter optional |
The Device Filter.
Possible Values: all | desktop | mobile |
action_ppcfilter optional |
The PPC Referral Network Filter.
Possible Values: google | bing | facebook | twitter | linkedin |
action_geofilter optional |
The Geo-Location Filter.
Possible Values: (Text) |
action_frequency optional |
The Action Frequency.
Possible Values: repeat | one_time |
delay_hours optional |
The Delay Number of Hours.
Possible Values: (Number) |
delay_minutes optional |
The Delay Number of Minutes.
Possible Values: (Number) |
delay_seconds optional |
The Delay Number of Seconds.
Possible Values: (Number) |
action_style optional |
Choose Action Style.
Possible Values: popup | sticky_bar |
action_text optional |
Action Text.
Possible Values: (Text) |
<PHP require_once('../PATH/TO/services/WebhookWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new WebhookWS($user_key); $parms = array( 'id' => '1', 'name' => 'webhook Name', 'action_type' => 'page_exit', ); $results = $app->addNewWebhook($parms); print_r($results); ?>POST https://api.vbout.com/1/webhook/add.json?key={YOUR_API_ID} id=1 name=webhook Name action_type=page_exit
https://api.vbout.com/1/webhook/edit
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the webhook.
Possible Values: (ID) |
name required |
The name of the webhook.
Possible Values: (Text) |
type required |
The type of the webhook.
Possible Values: page_exit | page_entry | goal_trigger |
action_url optional |
Page Url.
Possible Values: (Link) |
action_type required |
The type of the action.
Possible Values: html_msg | form | poll | redirection | trigger_js |
redirection_url optional |
Redirection URL.
Possible Values: (Link) |
list_id optional |
The List ID.
Possible Values: (ID) |
poll_question optional |
The Polling Question.
Possible Values: (Text) |
poll_choices optional |
The polling Choices.
Possible Values: (Text) |
js_code optional |
The Javascript Code.
Possible Values: (Text) |
action_startdate optional |
The Action Trigger Start Date.
Possible Values: (Date) |
action_enddate optional |
The Action Trigger End Date.
Possible Values: (Date) |
action_targetusers optional |
The Target Users.
Possible Values: all | subscribers | anonymous |
action_devicefilter optional |
The Device Filter.
Possible Values: all | desktop | mobile |
action_ppcfilter optional |
The PPC Referral Network Filter.
Possible Values: google | bing | facebook | twitter | linkedin |
action_geofilter optional |
The Geo-Location Filter.
Possible Values: (Text) |
action_frequency optional |
The Action Frequency.
Possible Values: repeat | one_time |
delay_hours optional |
The Delay Number of Hours.
Possible Values: (Number) |
delay_minutes optional |
The Delay Number of Minutes.
Possible Values: (Number) |
delay_seconds optional |
The Delay Number of Seconds.
Possible Values: (Number) |
action_style optional |
Choose Action Style.
Possible Values: popup | sticky_bar |
action_text optional |
Action Text.
Possible Values: (Text) |
<PHP require_once('../PATH/TO/services/WebhookWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new WebhookWS($user_key); $parms = array( 'id' => '1', 'name' => 'webhook Name', 'action_type' => 'page_exit', ); $results = $app->updateWebhook($parms); print_r($results); ?>POST https://api.vbout.com/1/webhook/edit.json?key={YOUR_API_ID} id=1 name=webhook Name action_type=page_exit
https://api.vbout.com/1/webhook/delete
Response formats | JSON/XML |
Requires authentication? | Yes |
id required |
The ID of the webhook to delete.
Possible Values: (ID) |
<PHP require_once('../PATH/TO/services/WebhookWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new WebhookWS($user_key); $parms = array( 'id' => '1', ); $results = $app->removeWebhook($parms); print_r($results); ?>POST https://api.vbout.com/1/webhook/delete.json?key={YOUR_API_ID} id=1
https://api.vbout.com/1/register/createaccount
Response formats | JSON/XML |
Requires authentication? | Yes |
contact_name required |
The contact name.
Possible Values: (Text) |
business_name required |
The business name.
Possible Values: (Text) |
business_email required |
The business email.
Possible Values: (Email) |
business_phone required |
The business phone.
Possible Values: (Text) |
business_vbout_name (optional) |
The business VBOUT name.
Possible Values: (Text) |
business_password (optional) |
The business password.
Possible Values: (Text) |
business_vat_number (optional) |
The business VAT number.
Possible Values: (Text) |
timezone (optional) |
The business timezone.
Possible Values: https://www.php.net/manual/en/timezones.php |
plan_id required |
The custom plan id.
Possible Values: (Number) |
commission_structure (optional) |
The commission structure.
Possible Values: (1: Discount to paid amount) | (2: Normal commission
payout) |
disable_billing_access (optional) |
Disable Billing Access.
Possible Values: 0 | 1 |
disable_settings_access (optional) |
Disable Settings Access.
Possible Values: 0 | 1 |
pay_on_signup (optional) |
Pay using agency saved card on success signup, and save the card to the newly created account.
Possible Values: 0 | 1 |
<PHP require_once('../PATH/TO/services/RegisterWS.php'); $user_key = array('api_key' => '{YOUR_API_KEY}'); $app = new RegisterWS($user_key); $parms = array( 'contact_name' => 'VBOUT TEST', 'business_name' => 'VBOUT TEST', 'business_email' => 'info@vobut.com', 'business_phone' => '123456789', 'business_vbout_name' => 'VBOUT TEST', 'business_password' => 'xxxxxxxxxxx', 'business_vat_number' => '123', 'timezone' => 'America/Los_Angeles', 'plan_id' => '10', 'commission_structure' => '1', 'disable_billing_access' => '0', 'disable_settings_access' => '1', 'pay_on_signup' => '1', ); $results = $app->createAccount($parms); print_r($results); ?>POST https://api.vbout.com/1/register/createaccount.json?key={YOUR_API_ID} contact_name=VBOUT TEST business_name=VBOUT TEST business_email=info@vobut.com business_phone=123456789 business_vbout_name=VBOUT TEST business_password=xxxxxxxxxxx business_vat_number=123 timezone=America/Los_Angeles plan_id=10 commission_structure=1 disable_billing_access=0 disable_settings_access=1 pay_on_signup=1