<img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=1822615684631785&amp;ev=PageView&amp;noscript=1"/>

How to use the GMass API

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.

Our API is the only API we know of that allows you to completely create and send a cold email campaign all from within the API, without ever having to do anything in the user interface.

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. You can add CC and BCC addresses here, as well as file attachments. 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.

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.

Ready to transform Gmail into an email marketing/cold email/mail merge tool?


Only GMass packs every email app into one tool — and brings it all into Gmail for you. Better emails. Tons of power. Easy to use.


TRY GMASS FOR FREE

Download Chrome extension - 30 second install!
No credit card required
Love what you're reading? Get the latest email strategy and tips & stay in touch.
   


13 Comments
  1. I am setting up a platform for my sales team, which will be 20 reps at first and then grow as ill be marketing it to others.

    What is your pricing for 100-2000 accounts?

    This would flow thru my portal. but we will using gmass for the engine as it pertains to emails.

    Is this be something you would be interested in?

  2. Need the pricing with currency. cant find the currency on the pricing page. need in-depth pricing. Also need to know which plans APi functionality is available and the charges for API

  3. How can I set the auto-follow up using the api? Like for example, if my recipient doesn’t answer the email within 3 days I want the sent a new one for him. I know I can do this using the gmass interface but I want to know how to do that using the API

  4. You are so cool! I don’t think I have read through anything like this before. So good to discover another person with some original thoughts on this subject matter. Really.. thank you for starting this up. This site is one thing that is needed on the internet, someone with a bit of originality.

  5. Într-o decizie recentă, instanța a admis acordul de recunoaștere a vinovăției în cazul lui Horațiu-Iuliu Vasiliu, un tânăr acuzat de deținere de droguri de risc pentru consum propriu. Sentința a fost pronunțată în baza articolului 485 alin. (1) lit. a) din Codul de Procedură Penală, de către Parchetul de pe lângă Înalta Curte de Casație și Justiție, prin Direcția de Investigare a Infracțiunilor de Criminalitate Organizată și Terorism.Vasiliu a fost condamnat la o pedeapsă de 10 luni de închisoare, rezultată din contopirea a două pedepse anterioare: 3 luni pentru o faptă comisă pe 8 iunie 2020 și 9 luni pentru o altă infracțiune din 10 octombrie 2021, ambele legate de deținerea de droguri. Instanța a stabilit, de asemenea, o pedeapsă complementară, interzicându-i exercitarea drepturilor de a fi ales în autoritățile publice și ocuparea unor funcții care implică exercițiul autorității de stat, pe o durată de 2 ani.Pe lângă pedeapsa privativă de libertate, instanța a dispus suspendarea executării pedepsei sub supraveghere pentru o perioadă de 2 ani, în care Vasiliu va trebui să respecte o serie de măsuri, inclusiv prezentarea la Serviciul de Probațiune și participarea la un program de reintegrare socială. De asemenea, el va presta muncă neremunerată în folosul comunității pentru o perioadă de 60 de zile.Instanța a dispus și confiscarea a 94,9 grame de cannabis și alte fragmente vegetale care conțin THC, care au fost depuse la Camera de Corpuri Delicte a Inspectoratului General al Poliției Române. Drogurile vor fi distruse, cu păstrarea de contraprobe, conform legislației în vigoare.

  6. One more thing. I believe that there are several travel insurance sites of dependable companies that let you enter your journey details and have you the prices. You can also purchase this international travel insurance policy online by using your credit card. All that you should do will be to enter your travel details and you can begin to see the plans side-by-side. Just find the plan that suits your finances and needs after which it use your credit card to buy that. Travel insurance on the internet is a good way to begin looking for a dependable company with regard to international travel insurance. Thanks for sharing your ideas.

  7. Thanks for the something totally new you have uncovered in your blog post. One thing I would like to touch upon is that FSBO associations are built after some time. By launching yourself to owners the first weekend break their FSBO can be announced, prior to a masses commence calling on Thursday, you make a good link. By giving them instruments, educational materials, free records, and forms, you become an ally. If you take a personal curiosity about them as well as their scenario, you generate a solid network that, many times, pays off in the event the owners opt with a realtor they know plus trust — preferably you.

  8. Message; TRANSFER 1.691571 bitcoin. Get >> https://graph.org/Payout-from-Blockchaincom-06-26?hs=d50ca9f59bc26674f007bec41ec0d03a& says:

    9w1wwz

  9. + 1.417006 BTC.NEXT - https://graph.org/Payout-from-Blockchaincom-06-26?hs=d50ca9f59bc26674f007bec41ec0d03a& says:

    1fyvhm

Leave a Reply

Your email address will not be published. Required fields are marked *

Transform your Gmail account into an email marketing powerhouse

GMass is easy to learn and easy to use — but brings unbelievable email power into Gmail

Try GMass for free Then check out the quickstart guide to send your first mail merge email in minutes!

GMass

Share This