APIs at MasterBase®

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.

Nuestros web services API

Our web service APIs

Use our web services APIs to facilitate and synchronize the actions to be performed.


Cree sus credenciales API

Create your API credentials

Before you begin, you must create the credentials that authorize you to make use of our APIs.

Integraciones API

MasterBase® Integrations

Integrate your company's internal systems with our platform and automate data handling.

Let's begin with MasterBase®

Contacts »

MassiveMail »

UniqueMail »

Archive »

Config »

Content »

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

Structure

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.

{
  "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"
}

Learn more about MasterBase APIs®

Contacts - Manage your contacts

/contacts/v2/{ClientName}/{ListId}
Gets information from your contacts.

/contacts/v2/{ClientName}/{ListId}
Deletes your contacts from 1 to 1.

/contacts/v2/{ClientName}
Gets information about submissions made to a contact.

/contacts/v2/{ClientName}
Creates or updates your contacts.

/contacts/v2/{ClientName}
Updates your contacts from 1 to 1.

/contacts/v2/{ClientName}/GetContacts/{ListId}
Gets information from your contacts by parameters.

MassiveMail - Manage your shipments

/massivemail/v1/{ClientName}
Performs a bulk send without a template

/massivemail/v1/{ClientName}
Performs a bulk send with template.

/massivemail/v1/{ClientName}
Modify a bulk shipment.

/massivemail/v1/{ClientName}/GetMail
Gets the summary of a submission by ID.

/massivemail/v1/{ClientName}/GetMails
Gets the summary of a parameterized submission.

/massivemail/v1/{ClientName}/GetStatistics
Gets the statistics for a submission.

/massivemail/v1/{ClientName}/GetEvent/{MailId}/{Event}
Gets details of events related to a submission.

UniqueMail - Manage your unique shipments

/UniqueMail/v3/{ClientName}
Performs a single send without a template.

/UniqueMail/v3/{ClientName}
Performs a single, templated submission.

/UniqueMail/v3/{ClientName}/Summary
Gets the summary of your submissions.

/UniqueMail/v3/{ClientName}/Statistics
Gets the statistics for your submissions.

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.

/Archive/v1/{ClientName}/GetByMailId
Gets the ULR of the sent EML, by Send ID.

/Archive/v1/{ClientName}/GetByEmail
Gets the ULR of the sent EML, by emailing the recipient.

Config - See configuration data

/Config/v1/{ClientName}/Fields/{ListId}
Gets the information for the fields on a base.

Content - Manage the contents of your account

/Content/v1/{ClientName}
Gets information from the contents of your account.

/Content/v1/{ClientName}
Modifies states and dates in a content.

If you need our help, contact Customer Service by clicking Here