Introduction

The Go-Mailer API is structured around REST. Our APIs are designed to enable our users to manage important resources within their accounts.

The APIs are designed to possess predictable URL structures and to support the most common HTTP verbs and error codes.

curl https://api.go-mailer.com/<endpoint-path>

You can use or utility packages for various programming languages

Node.js

yarn add @go-mailer/go-mailer

Python

pip install gomailer

PHP

# composer.json { "require": { "go-mailer/go-mailer": "~1.0" } } # usage <?php require_once 'vendor/autoload.php'; // Application code... ?>

Authentication

The Go-Mailer API uses API Keys to authenticate all requests. Your keys are accessible under Security settings in your account.

Your API Key possesses elevated privileges within your account; please keep it safe and secure. Do not share your key in publicly accessible areas.

HTTP requests are authenticated using Bearer Auth.

curl https://api.go-mailer.com/<endpoint-path> -H "Authorization: Bearer <API_KEY>"

Response body

error - string | null

This is an optional message indicating any errors that occurred during the processing of the request. If no error occurs, this value is null

payload - object | null

This is an optional key => value pairs of information returned with successful responses. This property value is `null` when an error occurs whilst processing the request.

payload.data - Resource | Resource[]

This contains the actual Object or a list of Objects for which the request is made

payload.meta.size - number

This returns a count of the instances of the Resource that matches the query.

Response codes

200 - OK

Everything worked as expected.

400 - Bad Request

The request was unacceptable, often due to missing a required parameter.

403 - Unauthorized

The request does not have required authorization. Usually due to incorrect API Keys.

404 - Not Found

The requested resource doesn't exist.

500 - Server Errors

Something went wrong on the Go-Mailer servers.