We’ve launched a beta version of the GMass API that can handle basic GMass functionality around creating lists and sending campaigns. Over time, we’ll be adding more functionality, like accessing reporting data.

Getting Started

All endpoints begin with https://api.gmass.co/api/. The API is mostly RESTful and conforms to OpenAPI standards. To get started with the API:

1. Create an API Key in your Dashboard. Go to the “API Keys” section.
2. Visit the API homepage, which serves as a reference for all API methods.
3. You can perform a test API call to retrieve all the Google Sheet titles in your account with this URL: https://api.gmass.co/api/sheets?apikey=your-api-key
4. You can access test forms for all methods using our Swagger-generated site here. Note that the Swagger site does include descriptions of methods, but the more comprehensive documentation is at https://api.gmass.co/docs.

Authentication

You can authenticate into the API using your API key and passing it either:

1. Via the query string as “apikey”
2. Via an HTTP header using X-apikey

Note that it must be passed as “apikey” and not any other variation of that. api-key and api_key will not work.

How to send a campaign

The basic steps of sending a campaign through the API are similar to the steps you would take in the Gmail interface with the Chrome extension.

1. Determine the Google Sheet and the corresponding Worksheet that your email list is in using the /api/sheets and api/sheets/{sheetid}/worksheets endpoints.
2. Create a GMass list address (for example: [email protected]) using the /api/lists endpoint, in which you’ll use the spreadsheetId and worksheetId from step 1.
3. Create a campaign DRAFT using the /api/campaigndrafts endpoint. This will return a Gmail DRAFT Id, which you can then use to send a campaign.
4. Send the campaign with the /api/campaigns endpoint and pass in the Gmail DRAFT Id from step 3, plus other campaign settings.

You can store the GMass alias addresses and reuse them in campaigns, and thereby skip steps 1 and 2 most of the time.

We’ll be adding endpoints, functionality, and better documentation with time.

What else can you do?

Retrieve a list of all your campaigns using the campaigns method.

Retrieve the lists of recipients, opens, clicks, replies, unsubscribes, and bounces for a particular campaign.

Retrieve your warmup statistics if you have warmup turned on.

Send a transactional email through your Google account. You can view a log of your transactional emails inside your dashboard.

Error handling

All calls to the API will return an HTTP 200 OK status code if the method call is successful.

If you don’t get an HTTP 200 OK status code, your code can assume there has been an error. Error codes include:

• HTTP 401 Unauthorized: Passing in an invalid API key
• HTTP 400 Bad Request: Passing in an invalid spreadsheet ID or invalid campaign ID
• HTTP 404 Not Found: Calling a method that doesn’t exist. For example, https://api.gmass.co/api/invalidmethodname will return a 404
• HTTP 500 Internal Server Error: Calling a method where the result is an error that is unexpected

Al API errors are logged and reported to our sysadmins. If we see a lot of errors from your account, you’ll likely be hearing from our support team.

Webhooks

The API described above allows you to poll GMass for information related to your campaigns and account. You might also be interested in our webhooks API which can “push” notifications to your server upon events like sends, opens, clicks, replies, unsubscribes, and bounces.

Ajay Goel

Ajay is the founder of GMass and has been developing email sending software for 20 years.