Overview

Intro

Backend API (server side) is a secure way to exchange information. Please be sure you have already created an account at sendmunk and you have generated your API public and Private Keys. If you have not done that yet, follow the steps below to get started:

  1. If you have not created an account at Sendmunk, please go to the Registration page. If you already have an account - login here.
  2. Once you're logged into sendmunk, goto API keys under Settings menu to create your API keys or Click here
Endpoint

Current endpoint link: https://sendmunk.com/api/v1/

Authentication

Available authentification method - API key.

Curl example:

To get your API key go to https://sendmunk.com/api-keys

SubAccounts

GET /subaccounts

Required parameters
  • api_secret  - Your API private key.

Responses

With every request you'll get these responses:

Response Status Description
200 OK The request has succeeded.
201 Created The request has been fulfilled and resulted in a new resource being created.
202 Accepted API call has been accepted for processing. This code will be returned by for asynchronous operations (Batches).
204 No content The server successfully processed the request, but is not returning any content
400 Bad Request invalid parameters, fields or filters
401 Unauthorized authorization error (invalid basic auth data or API key)
403 Forbidden The server understood the request, but is refusing it (blocked due to many errors in particular time) or the access is not allowed.
404 Not found There is no resource behind the URI.
422 Unprocessable Entity used if the server cannot process the enitity, e.g. mandatory fields are missing in the payload.
429 Too many requests Rate limit exceeded.
503 Internal server error We were unable to handle the HTTP request due to a temporary overloading or maintenance of the server. Please try again later.

HTTP Methods

API supports 3 HTTP methods for interacting with resources:

  • GET — request used to retrieve data. Never used to delete, update or insert data.
  • POST — request used to insert/Update/Delete data. Posted data type – JSON.
  • DELETE — remove data.