The main advantage of APIs in Masterbase® is that they allow you to automate actions that are performed on the web platform manually. Among other things, they make it possible to:
Update your databases in your work environment and on our platform, simultaneously.
Create and send messages from your systems without having to access our platform.
Receive from MasterBase® metrics for your shipments.
Use our web services APIs to facilitate and synchronize the actions to be performed.
Watch video »
Before you begin, you must create the credentials that authorize you to make use of our APIs.
Watch video »
Integrate your company's internal systems with our platform and automate data handling.
See more »Let's begin with MasterBase®
MasterBase® API
To construct the URL of the service you want to consume, you must do so with the following structure:
Base URL that groups Contacts services:
https://api2019.masterbase.com/
o which you must first add the segment that indicates the service you are pointing to, and then the optional parameters that define your query in question. The first of these preceded by a question mark (?), followed by an equals sign and the value of the parameter. From the second parameter you need to add, you must use the ampersand (&) sign instead of the question mark.
Example:
https://api2019.masterbase.com/contacts/v2/ClientName/?From=123&Top=100&Order=1
The Envelope
Each answer is contained in a structure called envelope. This means that each response has a predefined structure with which you can interact.
English
Español{
"Service": "Service Name",
"Version": "Version the service",
"TransactionId": "TransactionId",
"Status": {
"Code": "Answer Code",
"Value": "Value of response"
},
"Data": {}
}
Status
The status key is used to obtain information about the service response. If everything has followed its course correctly, the response will indicate in the Code attribute a value of 200 or 201. However, something may fail, in which case the response to be obtained is of this type:
"Status": {
"Code": "401",
"Value": "Unauthorized"
}
Authentication
For the consumption of the web services available on this site, it is necessary to consider that access authentication is basic and for which the API credentials – user and password - obtained through your MasterBase® account are used. The use of these will depend on the language chosen for the consumption of the services and it is the responsibility of the person who performs the same.
Learn more about MasterBase APIs®
Contacts - Manage your contacts
/contacts/v2/{ClientName}/{ListId}
Gets information from your contacts.
Gets information from your contacts
Parameters endpoints
Name
ClientName*
ListId*
Email*
From*
Top*
Order*
Description
Account name.
Contact base identifier.
Email from the contact to search.
Indicates the ID of the first contact in the list.
Indicates the number of contacts the list displays.
Indicates the order of the list: By date of contact creation (0 ascending, 1 descending).
Type
string($string) - (path)
number($string) - (path)
string($string) - (query)
string($string) - (query)
string($string) - (query)
string($string) - (query)
(*) Mandatory parameter
Email, From, Top, and Order are parameters to include in the consumption of a web service. respecting the following premises:
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contacts": {
"Contact": [{
"idContact": "451028",
"Email": "example@mail.com",
"Gender": "M",
"CreatedBy": "Usuario",
"ModifiedBy": "Admin",
"DateModification": "2018-01-17T20:23:34.193",
"FieldStr01": "John",
"FieldStr02": "Doe",
"FieldDte01": "1900-01-01T00:00:00"
}
]
}
}
}
400
No Data
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Code": "NoData",
"Value": "No Data"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFound",
"Value": "User not found"
}
}
500
Internal error
Example Value | Model
{
"Message": "An error has occuried"
}
/contacts/v2/{ClientName}/{ListId}
Deletes your contacts from 1 to 1.
Deletes your contacts from 1 to 1
Parameters endpoints
Name
ClientName*
ListId*
Identifier*
Description
Account name.
Contact base identifier.
Email or Id of the contact to be searched.
Type
string($string) - (path)
number($integer) - (path)
string($string) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contact": {
"Email": "prueba46@prueba.cl",
"Deleted": "True"
}
}
}
400
No Data
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Code": "NoData",
"Value": "No Data"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFound",
"Value": "User not found"
}
}
500
Internal error
Example Value | Model
{
"Message": "An error has occuried"
}
/contacts/v2/{ClientName}
Gets information about submissions made to a contact.
Gets information about submissions made to a contact
Parameters endpoints
Name
ContactId*
ListId*
Order
ExtraDetail
Description
Account name.
Contact ID.
Indicates the order in which messages will be listed: By the scheduled date.
Indicates whether details of shipments made (true/false) are required.
Type
string($string) - (path)
number($integer) - (query)
integer - (query)
boolean - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Response": {
"PageDetail": {
"TotalRecords": "340",
"CurrentPage": "1",
"TotalPage": "23"
},
"Summary": {
"TotalOpens": "45",
"TotalWebViews": "1",
"TotalCliks": "23",
"TotalBounces": "23"
},
"Mails": {
"Mail": [{
"id": "1022",
"Open": "2",
"WebView": "1",
"TotalClicks": "0",
"TotalBounces": "0",
"Detail": {
"Links": {
"Link": {
"Url": "http://www.es.masterbase.com/?utm_campaign=4329:%20Ejemplo%20&utm_source=MasterBase%20Cliente&utm_medium=email&utm_content=3&utm_term=none",
"Total": "1"
}
},
"Bounces": {
"Bounce": {
"Code": "133",
"Total": "1"
}
}
},
"ExtraDetail": {
"Opens": {
"Open": {
"Country": "US",
"OS": "Linux",
"Patform": "Desktop",
"EventDate": "2016-09-02T16:45:11"
}
},
"Clicks": {
"Click": {
"Country": "US",
"OS": "Linux",
"Patform": "Desktop",
"EventDate": "2016-09-02T16:45:11"
}
}
}
}
]
}
}
}
}
400
No Data
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Code": "NoData",
"Value": "No Data"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFound",
"Value": "User not found"
}
}
500
Internal error
Example Value | Model
{
"Message": "An error has occuried"
}
/contacts/v2/{ClientName}
Creates or updates your contacts.
Creates or updates your contacts
Parameters endpoints
Name
ContactId*
Update
Body*
Description
Account name.
Indicates whether you want to update contacts (true/false).
Contact details to be created or updated.
Type
string($string) - (path)
boolean - (query)
(body)
Example Value | Model
{
"Request": {
"ListId": "1",
"Contacts": {
"Contact": [{
"Email": "example@mail.com",
"Gender": "M",
"FieldStr01": "John",
"FieldStr02": "Doe",
"FieldDte01": "1900-01-01T00:00:00"
}
]
}
}
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contacts": {
"Contact": [{
"Email": "example@mail.com",
"idContact": "451028",
"Validation": {
"Status": "PASSED"
},
"Operation": {
"Status": "UPDATED",
"text": "Successfully executed"
}
}
]
}
}
}
400
No Data
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Code": "NoData",
"Value": "No Data"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFound",
"Value": "User not found"
}
}
500
Internal error
Example Value | Model
{
"Message": "An error has occuried"
}
/contacts/v2/{ClientName}
Updates your contacts from 1 to 1.
Updates your contacts from 1 to 1
Parameters endpoints
Name
ClientName*
Body*
Description
Account name.
Contact details update.
Type
string($string) - (path)
(body)
Example Value | Model
{
"Request": {
"ListId": "1",
"Contact": {
"Email": "example@mail.com",
"Gender": "M",
"FieldStr01": "John",
"FieldStr02": "Doe",
"FieldDte01": "1900-01-01T00:00:00"
}
}
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contacts": {
"Contact": [{
"Email": "example@mail.com",
"idContact": "451028",
"Validation": {
"Status": "PASSED"
},
"Operation": {
"Status": "UPDATED",
"text": "Successfully executed"
}
}
]
}
}
}
400
No Data
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Code": "NoData",
"Value": "No Data"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFound",
"Value": "User not found"
}
}
500
Internal error
Example Value | Model
{
"Message": "An error has occuried"
}
/contacts/v2/{ClientName}/GetContacts/{ListId}
Gets information from your contacts by parameters.
Gets information from your contacts by parameters
Parameters endpoints
Name
ClientName*
ListId*
Field*
Value*
Top
Op*
PageNumber
PageSize
Order
Description
Account name.
Contact base identifier.
The filter field.
Filter value.
Indicates the number of contacts the list will display.
Operator that will apply the filter.
Operator that will apply the filter.
Number of records to display per page.
Indicates the order in which messages will be listed: By creation date.
Type
string($string) - (path)
integer($int32) - (path)
string - (query)
string - (query)
string($string) - (query)
string - (query)
string - (query)
string - (query)
string - (query)
(*) Mandatory parameter
Allowed values for the operator attribute
Operator Value
eq
neq
sw
contain
notcontains
gt
Lt
gte
lte
null
notnull
Correlation
Same as
Different from
Start with
Contains
Does not contain
Greater than
Less than
Greater than or equal to
Less the same as
Null
Not null
Type
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
string - (query)
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"PageDetail": {
"CurrentPage": "1",
"TotalPages": "2323",
"TotalRecords": "5342",
"Contacts": {
"Contact": [{
"idContact": "451028",
"Email": "example@mail.com",
"Gender": "M",
"CreatedBy": "Usuario",
"ModifiedBy": "Admin",
"DateModification": "2018-01-17T20:23:34.193",
"FieldStr01": "John",
"FieldStr02": "Doe",
"FieldDte01": "1900-01-01T00:00:00"
}
]
}
}
}
}
400
No Data
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Code": "NoData",
"Value": "No Data"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "5c60b7bcd4f5620f627d0346b796c765",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFound",
"Value": "User not found"
}
}
500
Internal error
Example Value | Model
{
"Message": "An error has occuried"
}
MassiveMail - Manage your shipments
/massivemail/v1/{ClientName}
Performs a bulk send without a template.
Performs a bulk send without a template
Parameters endpoints
Name
Account name*
Body*
Description
Name of the customer's account.
Data of the message to be sent.
Type
string($string) - (path)
(body)
Parameters body
Classification
Name*
Description
SubCategoryId
Based on Type
Based on Id
From Type*
From Id*
ListId*
FilterType*
Ids*
Subject*
Format*
Now*
OpenTracking*
ClickTracking*
Enable*
Only "C" or "T" (Commercial/Transactional) values are accepted by default, Commercial is assumed.
Name of the mail.
Description of the message.
Subcategory identifier.
It only accepts "template" value.
Template Id.
Accepts only "Standard" or "Dynamic" values.
Sender numeric identifier.
Identifier of the contact list on which the messages will be made.
It only accepts "Static", "Dynamic" or "Newsletter" values.
List of identifiers associated with the selected filter, only allows multiple identifiers the newsletter filter type.
Subject of the message.
Accepts only "html" or "text" values.
Accepts only true or false values, assumes true value by default.
Accepts only true or false values.
Accepts only true or false values.
Accepts only true or false values.
Text
Text
Text
Number
Text
Number
Text
Number
Number
Text
Number
Text
Text
Text
Text
Text
Text
The template used must have in the message body the tag ‹ attachfile /› and the file to attach must be preloaded on the system via File Bunker.
Example Value | Model
{
"GeneralData": {
"Name": "Prueba de Envio",
"Description": "Dato Opcional",
"SubCategory": "1",
"Classification": "C"
},
"From": {
"Type": "Standard",
"Id": "1"
},
"To": {
"Ids": [
"4"
],
"ListId": "1",
"FilterType": "Dynamic"
},
"Message": {
"Subject": "Asunto del correo",
"Body": {
"Format": "html",
"Value": "<!DOCTYPE html><html> Cuerpo del correo <html>"
}
},
"Options": {
"SendDate": {
"Now": "false",
"Value": "2018-01-30T09:38:00-03:00"
},
"OpenTracking": "true",
"ClickTracking": "true",
"Enable": "false"
}
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contacts": {
"Contact": [{
"Email": "example@mail.com",
"idContact": "451028",
"Validation": {
"Status": "PASSED"
},
"Operation": {
"Status": "UPDATED",
"text": "Successfully executed"
}
}
]
}
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/massivemail/v1/{ClientName}
Performs a bulk send with template.
Performs a bulk send with template.
Parameters endpoints
Name
Account name*
Body*
Description
Name of the customer's account
Data of the message to be sent.
Type
string($string) - (path)
(body)
Parameters body
Classification
Name*
Description
SubCategoryId
Based on Type
Based on Id
From Type*
From Id*
ListId*
FilterType*
Ids*
Subject*
Format*
Now*
OpenTracking*
ClickTracking*
Enable*
Only "C" or "T" (Commercial/Transactional) values are accepted by default, Commercial is assumed.
Name of the message.
Description of the message.
Subcategory identifier.
It only accepts "template" value.
Template ID.
Accepts only "Standard" or "Dynamic" values.
Sender numeric identifier.
Identifier of the contact list on which the shipment will be made.
It only accepts "Static", "Dynamic" or "Newsletter" values.
List of identifiers associated with the selected filter, only allows multiple identifiers the newsletter filter type.
Subject of the message.
It only accepts values“html” o “text”.
Accepts only true or false values, assumes true value by default.
Accepts only true or false values.
Accepts only true or false values.
Accepts only true or false values.
Text
Text
Text
Number
Text
Number
Text
Number
Number
Text
Number
Text
Text
Text
Text
Text
Text
The template used must have in the message body the tag ‹ attachfile /› and the file to attach must be preloaded on the system via File Bunker.
Depending on the delivery or omit a value for the Subject parameter, the service will take the given value or assume as the subject of the selected template.
Example Value | Model
{
"GeneralData": {
"Name": "Correo promocional campaña Noviembre",
"Description": "Correo que contiene la campaña promocional de nov.",
"SubCategoryId": "2",
"Classification": "C",
"BasedOn": {
"Type": "template",
"Id": "1"
}
},
"From": {
"Type": "Standard",
"Id": "1"
},
"To": {
"Ids": [
"1"
],
"ListId": "1",
"FilterType": "Newsletter"
},
"Message": {
"Subject": "Campaña Noviembre",
"Body": {
"Format": "html",
"Value": "<!DOCTYPE html><html> Cuerpo del correo <html> "
}
},
" Options ": {
" SendDate ": {
" now ": " false ",
" value ": " 2016 - 09 - 05 20: 30: 00 "
},
" OpenTracking ": " false ",
" ClickTracking ": " true ",
" Enable ": " true "
}
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contacts": {
"Contact": [{
"Email": "example@mail.com",
"idContact": "451028",
"Validation": {
"Status": "PASSED"
},
"Operation": {
"Status": "UPDATED",
"text": "Successfully executed"
}
}
]
}
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/massivemail/v1/{ClientName}
Modify a bulk shipment.
Modify a bulk shipment
Parameters endpoints
Name
ClientName*
Body*
Description
Account name.
Data to be updated in the generated draft.
Type
string($string) - (path)
(body)
Example Value | Model
{
"GeneralData": {
"MailId": "5401",
"SubcategoryId": "2"
},
"From": {
"Type": "Standard",
"Id": "1"
},
"To": {
"Ids": [
"4"
],
"ListId": "1",
"FilterType": "Dynamic"
},
"Message": {
"Subject": "Asunto del correo",
"Body": {
"Format": "html",
"Value": "<!DOCTYPE html><html> Cuerpo del correo <html>"
}
},
"Options": {
"SendDate": {
"Now": "false",
"Value": "2018-01-30T09:38:00-03:00"
},
"OpenTracking": "true",
"ClickTracking": "true",
"Enabled": "false"
}
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"MailId": {
"AccountStatus": "User",
"Value": "10291"
},
"TransactionId": "RST01_20180130_44c2af5ef1984651bf9f0aad1264b2df",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/massivemail/v1/{ClientName}/GetMail
Gets the summary of a submission by ID.
Gets the summary of a submission by ID
Parameters endpoints
Name
ClientName*
MailId*
Description
Account name.
Shipping ID.
Type
string($string) - (path)
integer($int64) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Response": {
"AccountTipe": "T",
"MassiveMail": {
"Id": "7024",
"Name": "Nombre del envio",
"Subject": "Asunto del envio",
"Status": "E",
"Creator": "email@dominio.com",
"SentDate": "2017-08-09T13:25:01.717",
"EnabledBy": "email@dominio.com",
"EnabledDate": "2017-08-09T13:25:01.717",
"Total": "1000",
"CategoryId": "1",
"Category": "Categoria Test",
"SubCategoryId": "1",
"SubCategory": "Test Interno"
}
},
"TransactionId": "RST01_20180130_44c2af5ef1984651bf9f0aad1264b2df",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/massivemail/v1/{ClientName}/GetMail
Gets the summary of a parameterized submission.
Gets the summary of a parameterized submission
Parameters endpoints
Name
ClientName*
PageNumber
PageSize
StartDate
EndDate
CategoryId
SubCategoryId
Creator
EnabledBy
Subject
Description
Account name.
Page number to view.
Number of records per page.
Start date of the list of shipments.
End date of the list of shipments.
The id of the shipment category.
The ID of the subcategory of the shipment.
Email or credential of the send creator.
Email or credential from the send enabler.
Shipping subject.
Type
string - (path)
string - (query)
string - (query)
string - (query)
string - (query)
integer($int32) - (query)
integer($int32) - (query)
string - (query)
string - (query)
string($string) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Response": {
"AccountTipe": "T",
"MassiveMail": {
"Id": "7024",
"Name": "Nombre del envio",
"Subject": "Asunto del envio",
"Status": "E",
"Creator": "email@dominio.com",
"SentDate": "2017-08-09T13:25:01.717",
"EnabledBy": "email@dominio.com",
"EnabledDate": "2017-08-09T13:25:01.717",
"Total": "1000",
"CategoryId": "1",
"Category": "Categoria Test",
"SubCategoryId": "1",
"SubCategory": "Test Interno"
}
},
"TransactionId": "RST01_20180130_44c2af5ef1984651bf9f0aad1264b2df",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/massivemail/v1/{ClientName}/GetStatistics
Gets the statistics for a submission.
Gets the statistics for a submission
Parameters endpoints
Name
ClientName*
MailId
PageNumber
PageSize
StartDate
EndDate
CategoryId
SubCategoryId
EnabledBy
Creator
EnabledBy
Subject
ExtraDetail
Order
Description
Account name.
Shipping ID.
Page number in sight.
Number of records per page.
Start date of shipment listing.
End date of shipment listing.
Shipping category identifier.
Shipping subcategory identifier.
Send enabler email or credential.
Email or credential of the creator of the shipment.
Send enabler email or credential.
Shipping subject.
Indicates whether detailed statistics will be obtained.
Indicates listing order: By shipping date (0 ascending, 1 descending).
Type
string - (path)
integer($int64) - (query)
string - (query)
string - (query)
string - (query)
string - (query)
integer($int32) - (query)
integer - (query)
string($int32) - (query)
string - (query)
string - (query)
string - (query)
boolean - (query)
string($string) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Response": {
"AccountType": "T",
"CurrentPage": "1",
"TotalPage": "500",
"TotalRecords": "3200",
"MassiveMail": {
"Statistics": [{
"MailId": "10234",
"Sent": "1000",
"Open": "700",
"OpenUnique": "450",
"OpenPixelTracking": "45",
"OpenWebview": "1",
"OpenClicDeduced": "23",
"Bounce": "2",
"BounceUnique": "2",
"Click": "333",
"ClickUnique": "163",
"NotOpen": "300",
"Accepted": "689",
"Acepted_Rate": "98.0000",
"TAC": "75.0000",
"CTR": "75.0000",
"CTO": "75.0000",
"ExtraDetail": {
"Opens": [{
"OpenDetail": "101",
"Country": "US",
"OS": "Linux",
"Patform": "Desktop",
"EventDate": "2016-09-02T16:45:11"
}
],
"Links": [{
"OpenDetail": "101",
"Country": "US",
"OS": "Linux",
"Patform": "Desktop",
"EventDate": "2016-09-02T16:45:11"
}
],
"Bounces": [{
"OpenDetail": null,
"Country": null,
"OS": null,
"Patform": null,
"EventDate": "2016-09-02T16:45:11"
}
]
}
}
]
}
},
"TransactionId": "RST04_20180201_bfb8cbfaf1ff45528b0073cbaae06805",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/massivemail/v1/{ClientName}/GetEvent/{MailId}/{Event}
Gets details of events related to a submission.
Gets details of events related to a submission
Parameters endpoints
Name
ClientName*
MailId*
Event*
PageNumber
PageSize
Description
Account name.
Shipping ID.
Event type (sent, open, click, bounce)
Page number in sight.
Number of records per page.
Type
string - (path)
integer($int64) - (path)
string - (path)
string - (query)
string - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Response": {
"CurrentPage": "1",
"TotalPage": "1",
"TotalRecords": "1",
"Records": {
"Type": "open",
"Record": [
{
"Email": "correo@mail.com",
"EventDate": "2018-02-08T15:52:46",
"OperatingSystem": "Windows 7",
"Platform": "WinNT"
}
]
}
},
"TransactionId": "RST04_20180201_bfb8cbfaf1ff45528b0073cbaae06805",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
UniqueMail - Manage your unique shipments
/UniqueMail/v3/{ClientName}
Performs a single send without a template.
Performs a single send without a template
Parameters endpoints
Name
ClientName*
Body*
Description
Account name.
Data from the message to be sent.
Type
string($string) - (path)
(body)
Example Value | Model
{
"GeneralData": {
"FromName": "Nombre Remitente",
"From": "from@mail.com",
"To": {
"Email": [
"destinatario@mail.com"
]
},
"Cc": {
"Email": [
"destinatarioCC@mail.com"
]
},
"Bcc": {
"Email": [
"destinatarioBcc@mail.com"
]
},
"Message": {
"Subject": "Asunto del correo",
"Classification": "T",
"Body": {
"Format": "html",
"Value": "<!DOCTYPE html><html> Cuerpo del correo <html>"
},
"Attachment": [
{
"FileName": "a-b-c.csv",
"Encode": "Base64",
"Size": "1",
"Value": "ZW1haWw7bm9tYnJlDQphQGEuY29tO2ENCmJAYi5jb207Yg0KY0BjLmNvbTtjDQo="
}
]
},
"Options": {
"OpenTracking": "true",
"ClickTracking": "true",
"TextHtmlTracking": "true",
"AutoTextBody": "false"
}
}
}
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"Mails": [{
"Id": "W1C1d18d0b1cb52e4a2fa89d19af3fe9b44601"
}
]
},
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "200",
"Value": "OK"
},
"Error": {
"Code": "NoData"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFoundOrWithoutPermissions"
}
}
500
Internal error
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Code": "GeneralException"
}
}
/UniqueMail/v3/{ClientName}
Performs a single, templated submission.
Performs a single, templated submission
Parameters endpoints
Name
ClientName*
Body*
Description
Account name.
Data from the message to be sent.
Type
string($string) - (path)
(body)
Example Value | Model
{
"GeneralData": {
"FromName": "Nombre Remitente",
"From": "correo@remitente.com",
"To": {
"Email": ["emaildestintario1@mail.com", " emaildestintario2@mail.com "]
},
"Message": {
"Subject": "Asunto del envio",
"Classification": "C",
"BasedOn": {
"Id": "6",
"Type": "Template"
},
"Body": {
"Format": "html",
"Value": "obligatorio",
"Variables": [{
"Name": "VariableNombre",
"Value": "Claudia"
}, {
"Name": "VariableApellido",
"Value": "Carmona"
}, {
"Name": "VariableCargo",
"Value": "Editora de Contenidos"
}, {
"Name": "VariableCorreo",
"Value": "example@mail.com"
}
]
},
"Attachment": [{
"FileName": "NombreArchivo1.ext",
"Encode": "Base64",
"Size": "178",
"Value": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAf/9k="
}, {
"FileName": "NombreArchivo2.ext",
"Encode": "Base64",
"Size": "165",
"Value": "/9j/4AAQSkZJRgABAQAAAQABAAD//LCk/ZWo7P5SrG7hNWz+X6j8hGbTeV3r9goypgENJdfYEIgQiBCIEIgQiBCIEIgQiBCIEIgQiBC//2Q=="
}
]
},
"Options": {
"OpenTracking": "true",
"ClickTracking": "false",
"TextHtmlTracking": "true",
"AutoTextBody": "false",
"Personalization": "true"
}
}
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Service": "Contacts",
"Version": "1.0.9.0",
"TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c",
"Status": {
"Code": "200",
"Value": "OK"
},
"Data": {
"Contacts": {
"Contact": [{
"Email": "example@mail.com",
"idContact": "451028",
"Validation": {
"Status": "PASSED"
},
"Operation": {
"Status": "UPDATED",
"text": "Successfully executed"
}
}
]
}
}
}
400
No Data
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Mensaje": {
"Code": "InternalWarning"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "400",
"Value": "BadRequest"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Error": {
"Code": "InternalError"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "500",
"Value": "InternalServerError"
}
}
/UniqueMail/v3/{ClientName}/Summary
Gets the summary of your submissions.
Gets the summary of your submissions
Parameters endpoints
Name
ClientName*
MailId
PageNumber
PageSize
PageSize
StartDate
EndDate
To
Order
Description
Account name.
Shipping ID.
Page number in sight.
Number of records to display.
Number of records per page.
Start date of shipment listing.
End date of shipment listing.
Recipient's email address.
Indicates listing order: By shipping date (0 ascending, 1 descending).
Type
string($string) - (path)
integer($int64) - (query)
integer($int64) - (query)
integer($int64) - (query)
string - (query)
string - (query)
string - (query)
string - (query)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"PageDetail": {
"TotalRecords": "1232",
"CurrentPage": "1",
"TotalPages": "10"
},
"Mails": [{
"Id": "A16415e5cb09bea04952bb0e09e25ca6802301",
"RuleId": "30",
"Subject": "Asunto del mensaje",
"From": "remitente@mail.com",
"To": "destinatario@mail.com",
"Category": "Categoria Test",
"UrlEmlOriginal": "https://api.masterosr.com/out/v1/4/4/A16415e5cb09bea04952bb0e09e25ca6802301/o8bhex6cee64lxu20xmubwz7yrbxniws",
"UrlEmlProced": "https://api.masterosr.com/out/v1/4/4/A16415e5cb09bea04952bb0e09e25ca6802301/2bugbxkq7f6fqs1ul7elz7lwdov71j",
"ReceptionDate": "2017-11-21T15:21:23.867",
"SendDate": "2017-11-21T15:19:21.51",
"Status": "250"
}
]
},
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "200",
"Value": "OK"
},
"Error": {
"Code": "NoData"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "MassiveMail",
"Version": "1.0.14.0",
"Error": {
"Message": {
"Code": "AuthorizationFailure"
}
},
"TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
}
}
500
Internal error
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Code": "GeneralException"
}
}
/UniqueMail/v3/{ClientName}/Statistics
Gets the statistics for your submissions.
Gets the statistics for your submissions
Parameters endpoints
Name
ClientName*
MailId
PageNumber
PageSize
StartDate
EndDate
To
Order
Description
Account name.
Shipping ID.
Page number in sight.
Number of records to display.
Start date of shipment listing.
End date of shipment listing.
Recipient's email address.
Indicates listing order: By shipping date (0 ascending, 1 descending).
Type
string($string) - (path)
integer($int64) - (query)
integer($int64) - (query)
integer($int64) - (query)
string - (query)
string - (query)
string - (query)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"PageDetail": {
"TotalRecords": "1232",
"CurrentPage": "1",
"TotalPages": "10"
},
"Summary": {
"PageDetail": {
"Sents": "1",
"Opens": "1",
"Clicks": "2",
"Retries": "2",
"Accepteds": "1",
"AcceptedsRate": "100.0000",
"TACs": "0.0000",
"PCTRs": "0.0000",
"CTRs": "0.0000",
"PCTOs": "0.0000",
"CTOs": "0.0000"
}
},
"Mails": [{
"MailId": "A16415e5cb09bea04952bb0e09e25ca6802301",
"Retry": "2",
"Sents": "1",
"Opens": "1",
"Clicks": "2",
"Accepteds": "1",
"AcceptedsRate": "100.0000",
"TAC": "0.0000",
"PCTR": "0.0000",
"CTR": "0.0000",
"PCTO": "0.0000",
"CTO": "0.0000"
}
]
},
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "200",
"Value": "OK"
},
"Error": {
"Code": "NoData"
}
}
401
Unauthorized
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Code": "UserNotFoundOrWithoutPermissions"
}
}
500
Internal error
Example Value | Model
{
"Service": "UniqueMail",
"Version": "1.0.13.0",
"TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Code": "GeneralException"
}
}
Archive - Access the storage URL of your sent campaigns
/Archive/v1/{ClientName}/GetByRange
Gets the ULR of the sent EML, by date range and page number.
Gets the ULR of the sent EML, by date range and page number
Parameters endpoints
Name
ClientName*
PageNumber
PageSize
StartDate
EndDate
Order
Description
Account name.
Page number in sight.
Number of records to display.
Start date of shipment listing.
End date of shipment listing.
Indicates the order of the listing: By shipping date (0 ascending, 1 descending).
Type
string($string) - (path)
integer($int64) - (query)
integer($int64) - (query)
string - (query)
string - (query)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"PageDetails": {
"TotalRecords": "408",
"CurrentPage": "1",
"TotalPages": "204"
},
"Archives": {
"Archive": [{
"From": "remitente@mail.com",
"Serial": "25",
"MailId": "3099",
"Type": "0",
"IdResp": "111",
"MailUTCDate": "2016-12-15T13:34:14.973",
"ArchiveDate": "2017-01-05T21:40:18.700",
"Subject": "Asunto del envio",
"URL": "https://ss-scl01.masterosr.com/out/v1/AQ02B02/170102/CLIENTE/19/2016-12-15T10/CLIENTE.0.3099.25@sender19.masterbase.com.eml/e5897589e9e14ee9b53a10e7bad963a8"
}
]
}
},
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_01_20171102_e5897589e9e14ee9b53a10e7bad963a8",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "200",
"Value": "OK"
},
"Error": {
"Message": {
"Code": "NoData"
}
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Message": {
"Code": "UserNotFoundOrWithoutPermissions"
}
}
}
500
Internal error
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
/Archive/v1/{ClientName}/GetByMailId
Gets the ULR of the sent EML, by Send ID.
Gets the ULR of the sent EML, by Send ID
Parameters endpoints
Name
ClientName*
MailId*
Order
Description
Account name.
Shipping ID.
Number of records to display.
Type
string($string) - (path)
integer($int64) - (query)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"Archive": [{
"From": "remitente@mail.com",
"Serial": "25",
"MailId": "3099",
"Type": "0",
"IdResp": "111",
"MailUTCDate": "2016-12-15T13:34:14.973",
"ArchiveDate": "2017-01-05T21:40:18.700",
"Subject": "Asunto del envio",
"URL": "https://ss-scl01.masterosr.com/out/v1/AQ02B02/170102/CLIENTE/19/2016-12-15T10/CLIENTE.0.3099.25@sender19.masterbase.com.eml/e5897589e9e14ee9b53a10e7bad963a8"
}
]
},
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_01_20171102_e5897589e9e14ee9b53a10e7bad963a8",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "200",
"Value": "OK"
},
"Error": {
"Message": {
"Code": "NoData"
}
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
500
Internal error
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
/Archive/v1/{ClientName}/GetByEmail
Gets the ULR of the sent EML, by emailing the recipient.
Gets the ULR of the sent EML, by emailing the recipient
Parameters endpoints
Name
ClientName*
Email*
Order
Description
Account name.
Recipient's email address.
Indicates the order of the listing: By shipping date (0 ascending, 1 descending).
Type
string($string) - (path)
integer($int64) - (query)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"Archive": [{
"From": "remitente@mail.com",
"Serial": "25",
"MailId": "3099",
"Type": "0",
"IdResp": "111",
"MailUTCDate": "2016-12-15T13:34:14.973",
"ArchiveDate": "2017-01-05T21:40:18.700",
"Subject": "Asunto del envio",
"URL": "https://ss-scl01.masterosr.com/out/v1/AQ02B02/170102/CLIENTE/19/2016-12-15T10/CLIENTE.0.3099.25@sender19.masterbase.com.eml/e5897589e9e14ee9b53a10e7bad963a8"
}
]
},
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_01_20171102_e5897589e9e14ee9b53a10e7bad963a8",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "200",
"Value": "OK"
},
"Error": {
"Message": {
"Code": "NoData"
}
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Message": {
"Code": "UserNotFoundOrWithoutPermissions"
}
}
}
500
Internal error
Example Value | Model
{
"Service": "Archive",
"Version": "1.0.2.0",
"TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
Config - See configuration data
/Config/v1/{ClientName}/Fields/{ListId}
Gets the information for the fields on a base.
Gets the information for the fields on a base
Parameters endpoints
Name
ClientName*
ListId*
Description
Account name.
Contact base identifier.
Type
string($string) - (path)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"Field": [{
"Id": "84",
"Name": "Email",
"Display": "Email",
"IntTtpe": "Str",
"Required": "1",
"MinLength": "1",
"MaxLength": "150",
"ReadOnly": 0,
"PersonalizationString": "#!Email!#"
}
]
},
"Service": "Config",
"Version": "1.0.3.0",
"TransactionId": "CONFIG_04_20180223_9c7f1617f4d6408e8bba266d82f102f8",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "Config",
"Version": "1.0.3.0",
"TransactionId": "CONFIG_04_20180223_839ad16e729b4c8fa5c11d3ac16abf72",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Message": {
"Code": "WarningException"
}
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Config",
"Version": "1.0.3.0",
"TransactionId": "CONFIG_04_20180223_839ad16e729b4c8fa5c11d3ac16abf72",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Message": {
"Code": "CredentialsNotFound"
}
}
}
500
Internal error
Example Value | Model
{
"Service": "Config",
"Version": "1.0.3.0",
"TransactionId": "CONFIG_04_20180223_839ad16e729b4c8fa5c11d3ac16abf72",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
Content - Manage the contents of your account
/Content/v1/{ClientName}
Gets information from the contents of your account.
Gets information from the contents of your account
Parameters endpoints
Name
ClientName*
ListId*
Description
Account name.
Contact base identifier.
Type
string($string) - (path)
integer($int32) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": {
"Summary": {
"CurrentPage": 1,
"TotalPages": 1,
"TotalRecords": 1,
"Contents": [{
"Id": "84",
"Type": "Anuncio Inmobiliario",
"Name": "Inmobiliaria Saenz",
"CreationDate": "2017-03-21T14:17:11.287",
"Creator": "example@exmple.com",
"ModificationDate": "2017-03-21T14:17:11.287",
"Modificator": "example@exmple.com",
"EnableDate": "2017-03-21T14:17:11.287",
"ExpirationDate": "2017-03-21T14:17:11.287",
"Status": "2"
}
]
}
},
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_56078b29566c42d0a1c90a30074558fd",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Message": {
"Code": "WarningException"
}
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Message": {
"Code": "CredentialsNotFound"
}
}
}
500
Internal error
Example Value | Model
{
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
/Content/v1/{ClientName}
Modifies states and dates in a content.
Modifies states and dates in a content
Parameters endpoints
Name
ClientName*
ListId*
Body*
Description
Account name.
Contact list identifier.
Contact details to be modified.
Type
string($string) - (path)
integer($int32) - (path)
(body)
Example Value | Model
{
"Id": "159",
"EnableDate": "2018-07-14T00:00:00",
"ExpirationDate": "2018-07-30T03:00:00",
"Status": "1"
}
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{
"Data": "Updated",
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_56078b29566c42d0a1c90a30074558fd",
"Status": {
"Code": "200",
"Value": "OK"
}
}
400
No Data
Example Value | Model
{
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92",
"Status": {
"Code": "400",
"Value": "BadRequest"
},
"Error": {
"Message": {
"Code": "WarningException"
}
}
}
401
Unauthorized
Example Value | Model
{
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92",
"Status": {
"Code": "401",
"Value": "Unauthoraized"
},
"Error": {
"Message": {
"Code": "CredentialsNotFound"
}
}
}
500
Internal error
Example Value | Model
{
"Service": "Content",
"Version": "1.0.1.0",
"TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92",
"Status": {
"Code": "500",
"Value": "InternalServerError"
},
"Error": {
"Message": {
"Code": "ErrorException"
}
}
}
Process Automation
WebService RDS - Allows you to enter, update, and delete records in an RDS data collection
RDS bases, are non-relational databases, these are the ones used in our process automation platform. If you want to know more about this option make clic here
https://apirds2020.masterbase.com/find
To find records.
To find records.
Find records contained in a data collection, based on a particular filter (/find)
Responses
Code
/find
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
https://apirds2020.masterbase.com/findOne
To find a record.
To find a record.
Find a record that meets the conditions of a particular filter (/findOne)
Responses
Code
/findOne
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
https://apirds2020.masterbase.com/findOneAndUpdate
To find and update a record.
To find and update a record.
Find and update a record that meets the conditions of a particular filter (/findOneAndUpdate)
Responses
Code
/findOneAndUpdate
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
update: {"$set":{"customerData.campoN":"valor a actualizar"}}
options: {"returnOriginal":false}
https://apirds2020.masterbase.com/updateOne
To update a record.
To update a record.
Update a record that meets the conditions of a particular filter (/updateOne)
Responses
Code
/updateOne
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
update: {"$set":{"customerData.campoN":"valor a actualizar"}}
https://apirds2020.masterbase.com/updateMany
To update multiple records.
To update multiple records.
Update all records that meet the condition(s) of a given filter (/updateMany)
Responses
Code
/updateMany
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
update: {"$set":{"customerData.campoN":"valor a actualizar"}}
https://apirds2020.masterbase.com/insertOne
To insert a record.
To insert a record.
Enter a new record into the data collection (/insertOne)
Responses
Code
/insertOne
Description
Succesfull response
Example Value | Model
document: {"customerData: {"campo1":"valor a insertar", "campo2":"valor a insertar"}}
https://apirds2020.masterbase.com/deleteOne
To delete a record.
To delete a record.
Delete a record from the data collection, based on a particular filter (/deleteOne)
Responses
Code
/deleteOne
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
https://apirds2020.masterbase.com/deleteMany
To delete multiple records.
To delete multiple records.
Delete all records in a data collection that meet the condition(s) of a given filter (/deleteMany)
Responses
Code
/deleteMany
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
https://apirds2020.masterbase.com/count
To post records.
To post records.
Count records that meet the conditions of a given filter (/count)
Responses
Code
/count
Description
Succesfull response
Example Value | Model
filter: {"customerData.campo1": "valor a buscar","customerData.campo2": "valor a buscar"}
WebService - FileBunker
https://filein.filebunker.com
To store a document in FileBunker.
WebService FileBunker to perform an upload.
To store a document in FileBunker
Header
Content-Type*
x-api-key*
Description
Http message format.
Unique key for FileBunker access.
Type
string
string
Example Value | Content-Type
multipart/form-data
Example Value | x-api-key
ak1/mb/fb/XXXX/aaabbccdeef
(*) The unique key includes the client identifier: XXXX in this example, which corresponds to the clientID requested in the body metadata.
Name
fileName
Metadata
File
Description
Name and extension of the file to store.
JSON structure containing the parameters that the service requires to store the file.
File to upload.
Type
string (text)
string (JSON)
(file)
Example Metadata | Model
{
"fb": {
"keyLength": 100,
"clientID": "6157",
"daysToExpiration": 20,
"daysToPurge": 21
},
"createdBy": "jespinoza@masterbase.com"
}
(*) Mandatory parameter
https://out.filebunker.com/
Obtain the uploaded file.
To get a document stored in FileBunker
Parameters endpoints
Name
{{begins}}*
{{id}}*
{{key}}*
Description
corresponds to the value contained in metadata.customerIndex.begins, delivered as part of the response from the fileBunker service when a file is loaded.
corresponds to the value contained in metadata.id, delivered as part of the response from the fileBunker service when a file is loaded.
corresponds to the value contained in metadata.customerIndex.key, delivered as part of the response from the fileBunker service when a file is loaded.
Example Value | Content-Type
{
"metadata": {
"_id": "60e775ea21ac700012ff0534",
"mbData": {
"creationDate": "2021-07-08T22:02:18.526Z",
"createdBy": "jose.espinoza@masterbase.com",
"creationMethod": "IN"
},
"customerIndex": {
"storage": "W1_1057",
"begins": "I1012",
"key": "ho0jbeqo7rxuhp3fftpqdnksya4ql895f435ugok2jyajffrv46juff8pkg1xpmg2rshrndi7
yzeznkbqxg0p31hcxri34suflc5",
"numChunks": 2
}
}
}
(*) Mandatory parameter
If you need our help, contact Customer Service by clicking here