Introduction
Channels
Templates
Contacts
Messages
API
public
beta
Docs Contact About Login

API reference

The Notifuse API is a collection of RPC-style methods accessible via HTTPS at: https://api.notifuse.com/v2/METHOD

The format used for both requests & reponses body is JSON.

All the Notifuse platform is built upon the API, however, to keep things simple, only the contacts.upsert, messages.send & messages.info endpoints are documented here.

Feel free to contact us if you want to integrate other endpoints.

We recommend you to use Postman to play with our API. Click on the following button to import a pre-made collection of examples. You will also have to create a new Postman environment with a projectToken key.

Curl Node PHP

Libraries for the Notifuse API are available in several languages.

Authentication

All API requests are authenticated via an API key.

You can find your Notifuse API key in your project "Settings" (left sidebar in the UI).

Your API key should be provided with the Authorization and Content-Type HTTP headers like this:

Authorization: Bearer API_KEY
Content-Type: application/json


  {
    "Authorization": "Bearer API_KEY",
    "Content-Type": "application/json"
  }
          

  var notifuse = require('notifuse')({
    apiKey: API_KEY
  });
          

  curl -H 'Authorization: Bearer ${API_KEY}' \
       -H 'Content-Type: application/json'
          

  $notifuse = new Notifuse($API_KEY);
          

Errors

The Notifuse API uses conventional HTTP response codes to indicate the success or failure of a request.

Status codes in the 2xx range indicate success, 4xx indicate an error from the client-side (bad request format, missing parameters...) and 5xx indicate an error with Notifuse's servers.

All errors are formatted in a JSON object like this:

statusCode
integer
HTTP status code returned. (i.e: 200, 400...)
error
optional string
Kind of error (i.e: Bad Request, Unauthorized...)
message
optional string
Some hints to help you fix the problem ;)

HTTP codes used by Notifuse:

200 - OK Success!
201 - Created Resource created.
400 - Bad Request Wrong format or parameters.
401 - Unauthorized The Authorization header is missing or your API is not valid.
404 - Not Found The endpoint URL does not exist!
429 - Too Many Requests You exceeded the API rate-limit, wait a bit before retrying...
5xx - Server Errors There is something in the Notifuse API (should never happen though!).