VBOUT Contact API
The Contact API from VBOUT — 18 operation(s) for contact.
OpenAPI Specification
openapi: 3.1.0
info:
title: VBOUT EmailMarketing Contact API
version: '1.0'
description: VBOUT Features API documentation
servers:
- url: https://api.vbout.com/1
tags:
- name: Contact
paths:
EmailMarketing/GetContacts:
get:
summary: Contacts
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
x-examples:
example-1:
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
- '...'
properties:
contacts:
type: object
count:
type: integer
items:
type: array
items:
- type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
- type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
- type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
examples:
example-1:
value:
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
- '...'
operationId: get-EmailMarketing-GetContacts
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: '0'
in: query
name: ' listid'
description: The ID of the list to return its contacts.<br>**Possible values:** (IDs)
required: true
x-codeSamples:
- lang: cURL
source: 'GET https://api.vbout.com/1/emailmarketing/getcontacts.json?key={YOUR_API_ID}&listid=524
'
- lang: PHP
source: '<?php
require_once(''../PATH/TO/services/EmailMarketingWS.php'');
$user_key = array(''api_key'' => ''{YOUR_API_KEY}'');
$app = new EmailMarketingWS($user_key);
$listid = ''524'';
$results = $app->getMyContacts($listid);
print_r($results);
?>
'
tags:
- Contact
EmailMarketing/GetContactsByPhoneNumber:
get:
summary: Contacts By Phone Number
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
contacts:
type: object
properties:
count:
type: integer
items:
type: array
items:
- type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
- type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
- type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
examples:
example-1:
value:
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
- '...'
operationId: get-EmailMarketing-GetContactsByPhoneNumber
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: '0'
in: query
name: listid
required: true
description: The ID of the list to return its contacts.<br>**Possible values:** (IDs)
x-codeSamples:
- lang: cURL
source: GET https://api.vbout.com/1/EmailMarketing/GetContactsByPhoneNumber.json?key= {YOUR_API_ID}&phone=+19123456789&listid=524
- lang: PHP
source: '<?php
require_once(''../PATH/TO/services/EmailMarketingWS.php'');
$user_key = array(''api_key'' => ''{YOUR_API_KEY}'');
$app = new EmailMarketingWS($user_key);
$phone = ''+19123456789'';
$listid = ''524'';
$results = $app->getContactsByPhoneNumber($phone, $listid);
print_r($results);
?>
'
tags:
- Contact
EmailMarketing/GetContactByEmail:
get:
summary: Contact By Email
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
x-examples:
example-1:
contact:
id: '3'
email: jim@tester.com
status: '1'
registration_date: 11/30/1998 00:00
properties:
contact:
type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
examples:
example-1:
value:
contact":
id: '3'
email: jim@tester.com
status: '1'
registration_date: 11/30/1998 00:00
operationId: get-EmailMarketing-GetContactByEmail
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
x-codeSamples:
- lang: cURL
source: https://api.vbout.com/1/emailmarketing/getcontactbyemail
- lang: PHP
source: '<?php
require_once(''../PATH/TO/services/EmailMarketingWS.php'');
$user_key = array(''api_key'' => ''{YOUR_API_KEY}'');
$app = new EmailMarketingWS($user_key);
$phone = ''+19123456789'';
$listid = ''524'';
$results = $app->getContactsByPhoneNumber($phone, $listid);
print_r($results);
?>
'
parameters:
- schema:
type: string
default: none
format: email
in: query
name: email
required: true
description: The Email of the contact to return.**Possible values:** (Email)
- schema:
type: integer
default: none
in: query
name: listid
description: The List id of which this contact does belong to.**Possible values:**(ID)
tags:
- Contact
EmailMarketing/GetContact:
get:
summary: Contact
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
x-examples:
example-1:
contact:
id: '3'
email: jim@tester.com
status: '1'
registration_date: 11/30/1998 00:00
properties:
contact:
type: object
properties:
id:
type: integer
email:
type: string
status:
type: string
registration_date:
type: string
examples:
example-1:
value:
contact":
id: '3'
email: jim@tester.com
status: '1'
registration_date: 11/30/1998 00:00
operationId: get-EmailMarketing-GetContact
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: none
in: query
name: id
required: true
description: The ID of the contact to return.<br>**Possible values:** (ID)
x-codeSamples:
- lang: cURL
source: 'GET https://api.vbout.com/1/emailmarketing/getcontact.json?key={YOUR_API_ID}&id=3
'
- lang: PHP
source: '<?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);
?>
'
tags:
- Contact
EmailMarketing/AddContact:
post:
summary: Add Contact
operationId: post-EmailMarketing-AddContact
tags:
- Contact
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: string
default: None
in: query
name: ' status'
description: The status of the contact.<br>**Possible values:** (Active | Disactive)
required: true
- schema:
type: integer
in: query
name: listid
description: The ID of the list to assign this contact to.<br>**Possible values:** (ID)
required: true
- schema:
type: string
default: None
format: email
in: query
name: email
description: The email of the contact.<br>**Possible values:** (Email)
- schema:
type: string
default: None
in: query
name: ipaddress
description: The ip of the contact.<br>**Possible values:** (IP)
- schema:
type: array
default: None
in: query
name: fields
description: The list of custom fields added to a specific list.<br>**Possible values:** Array('fieldID'=>'fieldValue')<br><b>Accepted Date Formats:</b> Y-m-d | d-m-Y | m/d/Y
x-codeSamples:
- lang: cURL
source: POST https://api.vbout.com/1/emailmarketing/addcontact.json?key={YOUR_API_ID} email=info@example.com status=active listid=24 fields[125]=John fields[1204]=Doe fields[325]=1983-9-1
- lang: PHP
source: '<?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);
?>
'
EmailMarketing/EditContact:
post:
summary: Edit Contact
operationId: post-EmailMarketing-EditContact
tags:
- Contact
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: None
in: query
name: id
description: The ID of the contact.<br>**Possible values:** (ID)
required: true
- schema:
type: string
default: None
format: email
in: query
name: email
description: The email of the contact.<br>**Possible values:** (Email)
- schema:
type: string
default: None
in: query
name: ipaddress
description: The ip of the contact.<br>**Possible values:** (IP)
- schema:
type: string
default: None
in: query
name: status
description: The status of the contact.<br>**Possible values:** (Active | Disactive)
- schema:
type: array
default: None
in: query
name: fields
description: The list of custom fields added to a specific list.<br>**Possible values:** Array('fieldID'=>'fieldValue')<br><b>Accepted Date Formats:</b> Y-m-d | d-m-Y | m/d/Y
x-codeSamples:
- lang: cURL
source: "POST https://api.vbout.com/1/emailmarketing/editcontact.json?key={YOUR_API_ID}\n id=1\n email=info@example.com\n status=active\n listid=24\n fields[125]=John\n fields[1204]=Doe\n fields[325]=1983-9-1\n"
- lang: PHP
source: "\"<?php\nrequire_once('../PATH/TO/services/EmailMarketingWS.php');\n$user_key = array('api_key' => '{YOUR_API_KEY}');\n$app = new EmailMarketingWS($user_key);\n$params = array(\n 'id' => '1',\n 'email' => 'info@example.com',\n 'status' => 'active',\n 'listid' => '24',\n 'fields' => array('125' => 'John','1204' => 'Doe','325' => '1983-9-1',),\n);\n$results = $app->updateContact( $params );\nprint_r($results);\n?>\n"
EmailMarketing/SyncContact:
post:
summary: Sync Contact
operationId: post-EmailMarketing-SyncContact
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON` \n - - - \n**Note:** All emails having the same email text available in the provided list will be updated if exists (case email is not required)."
tags:
- Contact
parameters:
- schema:
type: string
default: None
format: email
in: query
name: email
description: The email of the contact.<br>**Possible values:** (Email)
required: true
- schema:
type: integer
default: None
in: query
name: listid
description: 'The ID of the list to assign this contact to.<br>**Possible values:** (ID) '
- schema:
type: string
default: None
in: query
name: ipaddress
description: The ip of the contact.<br>**Possible values:** (IP)
- schema:
type: string
default: None
in: query
name: status
description: The status of the contact.<br>**Possible values:** (Active | Disactive)
- schema:
type: array
default: None
in: query
name: fields
description: The list of custom fields added to a specific list.<br>**Possible values:** Array('fieldID'=>'fieldValue')<br><b>Accepted Date Formats:</b> Y-m-d | d-m-Y | m/d/Y
x-codeSamples:
- lang: cURL
source: "POST https://api.vbout.com/1/emailmarketing/synccontact.json?key={YOUR_API_ID}\n email=info@example.com\n status=active\n listid=24,25,12\n fields[125]=John\n fields[1204]=Doe\n fields[325]=1983-9-1\n"
- lang: PHP
source: "<?php\n require_once('../PATH/TO/services/EmailMarketingWS.php');\n $user_key = array('api_key' => '{YOUR_API_KEY}');\n $app = new EmailMarketingWS($user_key);\n $params = array(\n 'email' => 'info@example.com',\n 'status' => 'active',\n 'listid' => '24,25,12',\n 'fields' => array('125' => 'John','1204' => 'Doe','325' => '1983-9-1',),\n );\n $results = $app->syncContactMethod( $params );\n print_r($results);\n?>\n"
EmailMarketing/DeleteContact:
delete:
summary: Delete Contact
operationId: delete-EmailMarketing-DeleteContact
tags:
- Contact
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: None
in: query
name: id
description: The ID of the contact to delete.<br> **Possible values:** (ID)
required: true
- schema:
type: integer
default: None
in: query
name: listid
description: The ID of the list to delete from.<br> **Possible values:** (ID)
required: true
x-codeSamples:
- lang: cURL
source: POST https://api.vbout.com/1/emailmarketing/deletecontact.json?key={YOUR_API_ID} id=14523 listid=45678
- lang: PHP
source: "<?php\n require_once('../PATH/TO/services/EmailMarketingWS.php');\n $user_key = array('api_key' => '{YOUR_API_KEY}');\n $app = new EmailMarketingWS($user_key);\n $params = array(\n 'email' => 'info@example.com',\n 'status' => 'active',\n 'listid' => '24,25,12',\n 'fields' => array('125' => 'John','1204' => 'Doe','325' => '1983-9-1',),\n );\n $results = $app->syncContactMethod( $params );\n print_r($results);\n?>\n"
EmailMarketing/MoveContact:
post:
summary: Move Contact
operationId: post-EmailMarketing-MoveContact
tags:
- Contact
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: None
in: query
name: id
description: The ID of the contact.<br>**Possible Values:** (ID)
required: true
- schema:
type: integer
default: None
in: query
name: listid
description: 'The ID of the list to assign this contact to.<br>**Possible values:** (ID) '
required: true
- schema:
type: integer
default: None
in: query
name: sourceid
description: 'The ID of the list to assign this contact to.<br>**Possible values:** (ID) '
required: true
x-codeSamples:
- lang: cURL
source: "POST https://api.vbout.com/1/emailmarketing/movecontact.json?key={YOUR_API_ID}\n id=1\n listid=24\n"
- lang: PHP
source: "<?php\n require_once('../PATH/TO/services/EmailMarketingWS.php');\n $user_key = array('api_key' => '{YOUR_API_KEY}');\n $app = new EmailMarketingWS($user_key);\n $params = array(\n 'id' => '1',\n 'listid' => '24',\n );\n $results = $app->moveContact( $params );\n print_r($results);\n ?>\n"
EmailMarketing/GetContactTimeline:
get:
summary: Contact Timeline
tags:
- Contact
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: integer
email:
type: string
timeline:
type: object
properties:
data:
type: array
items:
type: object
properties:
key:
type: string
snippet:
type: string
timestamp:
type: integer
datetime:
type: string
details:
type: array
items:
type: object
properties:
key:
type: string
label:
type: string
value:
type:
- integer
- string
count:
type: integer
total:
type: integer
utm:
type: object
properties:
data:
type: array
items:
type: object
properties:
link:
type: string
utm:
type: object
properties:
campaign:
type: string
source:
type: string
medium:
type: string
term:
type: string
content:
type: string
timestamp:
type: integer
datetime:
type: string
count:
type: integer
automated:
type: object
properties:
data:
type: array
items:
type: object
properties:
name:
type: string
type:
type: string
timestamp:
type: integer
datetime:
type: string
details:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
count:
type: integer
x-examples:
example-1:
id: 123
email: example@example.com
timeline:
data:
- key: email-campaign-sent
snippet: 'Message: A test email campaign'
timestamp: 1653576048
datetime: 2022-05-26 05:40 PM
details:
- key: send-date
label: Send Date
value: 2022-05-26 05:40PM
- key: open-date
label: Opened
value: N/A
- key: links-clicked
label: Links Clicked
value: 0
- key: automation-triggered
snippet: 'Automation Triggered: Send Automation'
timestamp: 1648048427
datetime: 23-03-2022 05:13 PM
details:
- key: steps
label: Steps
value: 6
- key: actions
label: Actions
value: 6
count: 2
total: 2
utm:
data:
- link: https://www.test.com/page?utm_source=facebook&utm_medium=mobile&utm_campaign=ad-camoaign
utm:
campaign: ad-camoaign
source: facebook
medium: mobile
term: ''
content: ''
timestamp: 1656056618
datetime: 24-06-2022 10:43 AM
count: 1
automated:
data:
- name: Followup Message
type: sms
timestamp: 1648047960
datetime: 23-03-2022 05:06 PM
details:
- key: message
value: '[#FIRSTNAME#], thanks for contacting us! Just sent you an email with more details.'
- key: click-date
value: '-'
- name: Welcome Message
type: email
timestamp: 1648047900
datetime: 23-03-2022 05:05 PM
details:
- key: subject
value: Welcome to our company
- key: open-date
value: 27-03-2022 11:25 PM
- key: click-date
value: '-'
count: 2
examples:
example-1:
value:
id: 123
email: example@example.com
timeline:
data:
- key: email-campaign-sent
snippet: 'Message: A test email campaign'
timestamp: 1653576048
datetime: 2022-05-26 05:40 PM
details:
- key: send-date
label: Send Date
value: 2022-05-26 05:40PM
- key: open-date
label: Opened
value: N/A
- key: links-clicked
label: Links Clicked
value: 0
- key: automation-triggered
snippet: 'Automation Triggered: Send Automation'
timestamp: 1648048427
datetime: 23-03-2022 05:13 PM
details:
- key: steps
label: Steps
value: 6
- key: actions
label: Actions
value: 6
count: 2
total: 2
utm:
data:
- link: https://www.test.com/page?utm_source=facebook&utm_medium=mobile&utm_campaign=ad-camoaign
utm:
campaign: ad-camoaign
source: facebook
medium: mobile
term: ''
content: ''
timestamp: 1656056618
datetime: 24-06-2022 10:43 AM
count: 1
automated:
data:
- name: Followup Message
type: sms
timestamp: 1648047960
datetime: 23-03-2022 05:06 PM
details:
- key: message
value: '[#FIRSTNAME#], thanks for contacting us! Just sent you an email with more details.'
- key: click-date
value: '-'
- name: Welcome Message
type: email
timestamp: 1648047900
datetime: 23-03-2022 05:05 PM
details:
- key: subject
value: Welcome to our company
- key: open-date
value: 27-03-2022 11:25 PM
- key: click-date
value: '-'
count: 2
operationId: get-EmailMarketing-GetContactTimeline
description: "**Authentication:** `Required` \n - - - \n \n**Response Formats:** `XML | JSON`"
parameters:
- schema:
type: integer
default: None
in: query
name: ' id'
description: 'The ID of the contact to return his timeline activities.<br>**Possible values:** (ID) '
required: true
- schema:
type: string
default: None
in: query
name: include
description: 'Comma separated keys to return other details with the timeline activities. <br>**Possible values:** utm | automated '
x-codeSamples:
- lang: cURL
source: GET https://api.vbout.com/1/emailmarketing/getcontacttimeline.json?key={YOUR_API_ID}&id=3
- lang: PHP
source: "<?php\n require_once('../PATH/TO/services/EmailMarketingWS.php');\n $user_key = array('api_key' => '{YOUR_API_KEY}');\n $app = new EmailMarketingWS($user_key);\n $params = array(\n 'id' => '1',\n 'listid' => '24',\n );\n $results = $app->moveContact( $params );\n print_r($results);\n ?>\n"
EmailMarketing/GetContactTimelineByEmailAddress:
get:
summary: Contact Timeline By Email Address
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
id:
type: integer
email:
type: string
timeline:
type: object
properties:
data:
type: array
items:
type: object
properties:
key:
type: string
snippet:
type: stri
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vbout/refs/heads/main/openapi/vbout-contact-api-openapi.yml