https://api.mobiniti.com/v1

API Documentation

This document is for version 1 of the API.

Introduction

The Mobiniti API is a REST API. It is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors (though if you’re using one of our libraries, we will use exceptions to indicate an error).

Authentication

Overview

In order for an application to access the Mobiniti API, it needs to have a valid access token. The token is generated when a Mobiniti customer grants the application access to their account. An access token is currently valid for a period of 10 years, and the application needs to use it for each API call to the user’s Mobiniti resources. In simplest terms, you register your application with Mobiniti, parse a token from an HTTP response, and send the token to the Mobiniti API you wish to access. OAuth 2.0 lets a user authorize your application to access their private Mobiniti resources without having to share their log in credentials with your application.The OAuth 2.0 flows requires the following, which you can find in your Mobiniti account after you have registered for an account.

  1. Login to your Mobiniti account.

  2. Go to your settings page, click the integrations tab.

  3. Scroll down to the applications section, click ‘Create new application’ in the top right.

  4. Enter an application name and the redirect url (located on your server) and click 'Create Application’.

  5. A client id, consumer secret will be generated for you which are used to authenticate the application with Mobiniti.

Once the app is authenticated, and the Mobiniti user grants access to their account, the app receives an access_token to use when making API calls to that user’s account resources. The Mobiniti API supports the Server (authorization code) OAuth 2.0 authentication flows.

Request Permissions

Implementation Details

The OAuth2-specific endpoints you’ll need to worry about:

OAuth 2.0 Server Flow

The OAuth 2.0 server authentication flow is used whenever a Mobiniti account uses your integration for the first time. The Mobiniti user must login to their account and give permission to your application to access their Mobiniti account. The Server Authentication flow consists of 2 main transactions:

  • The app makes an authorization request.

    • The authorization server responds with an authorization code.

  • The app then makes an access token request using the authorization code.

  • The authorization server responds with an access token.

Authorization Request

Parameter Values Required Description
response_type code YES A value of code tells the authentication server it is sending an authorization code to a web server. It MUST be the code for server applications. (Scopes are below)
client_id YOUR_CLIENT_ID YES Identifies the app that is making the request to the server; this parameter MUST always be set to the exact value of the client id provider when creating an application.
redirect_uri YOUR_REDIRECT_URL YES Tells the Authorization Server where to send the user once access is granted. This must be the same redirect_uri that is associated with your applications when it was created.
scope Scopes YES A space delimited list of scopes
Scopes
campaigns.create campaigns.delete campaigns.update
campaigns.view contacts.create contacts.delete
contacts.update contacts.view coupons.create
coupons.delete coupons.update coupons.view
groups.create groups.delete groups.update
groups.view messages.create messages.unread.view
messages.update messages.view message.schedule.view
message.schedule.create message.schedule.update message.schedule.delete
optins.view phone-numbers.lookup carriers.view

Authorization Response

If the user grants the access request, the authorization server issues an authorization code and delivers it by adding it to the query component of the redirection URI.

Field Description
code Unique 27 character authorization code generated for the request. It is valid for 10 minutes, and must be exchanged for an access token in order to make API calls.
error Error label and description if an error condition is detected in the authentication request.

Access Token Request

After the application receives the authorization code, it must exchange it for an access token by making a call to the Token endpoint.

  1. The application requests an access token from the Mobiniti authentication server, providing its client_id, client_secret, redirect_URI and the authorization_code.

  2. The authorization server validates the client credentials, the authorization code, and the redirect_URI (it must match the redirect_uri used in the Authorization Request exactly, including any parameters added). If the validation is successful, the authorization server sends back an access token. The application needs to retain the access token and use it when making API calls on behalf of the user.

Parameter Values Required Description
grant_type authorization_code YES This parameter MUST always be set to 'authorization_code’
client_id your_API_KEY YES This parameter MUST always be set to the value of your_API_KEY
client_secret your_client_secret YES This parameter MUST always be set to the your_client_secret value associated with the API_key.
code unique_code YES MUST be set to the authorization code provided in the Authorization request response.
redirect_uri your_encoded_redirect_URI YES It must match the redirect URI used in the authorization request, including any parameters.

Access Token Response

Field Description
access_token hyphenated hexadecimal string used to make API calls to a users account.
expires_in 315359999 seconds - Tokens are currently valid for 10 years
token_type This is always set to Bearer

Personal Access Token

If you would like a quick way to experiment with the API or don't have a need for the authorization code redirect flow, you can create a personal access token.

Once you're logged in, use the following steps to generate a personal access token.

  1. Navigate to Settings -> Integrations tab -> Personal Access Tokens.

  2. Click "Create New Token" in the upper right corner of the Personal Access Tokens subsection.

  3. Enter a meaningful name for your reference in the future.

  4. Choose the scopes you would like to grant to this token.

  5. Click the "Create" button.

  6. A popup will display your new token, it will only be shown once so make sure it's stored in a safe place.

Filtering, Ordering & Pagination

Filtering

This API can filter returned collections based on provided query parameters.

For example, when requesting a list of contacts from the /v1/contacts endpoint, you may want to limit these to only those of a specific reward points. This could be accomplished with a request like GET /v1/contacts?filter[reward_points]=10.

Ordering

This API can sort returned collections. A generic query parameter sort is used to describe sorting rules. This parameter can take a list of comma separated field, each with a possible unary negative to imply descending sort order.

E.g. GET /v1/messages?sort=-created_at - Retrieves a list of messages in descending order by creation date.

Includes

On certain endpoints you can choose to include additional data by specifying an include query parameter.

E.g. GET /v1/groups/f82e541a-a4b1-11e8-a85f-127fd0971098/contacts?include[]=status&include[]=fields - Retrieves a list of contacts with the corresponding status and custom fields for each contact.

Pagination

To do pagination for list resources, the query string in the url should be used. The two parameters are ‘limit’ and ‘page’ with the default and max number of results being 100.

Example: GET /v1/groups/limit=20 - This will return 20 results per page. Under the ‘meta’ -> ‘pagination’ in the api response will have a few fields that are used for pagination. Total is the total number of records, per_page is essentially the limit parameter from the url. current_page and total_pages are self explanatory.

Under ‘links’ are the ‘next’ and ‘previous’ keys which are in the url to use and retrieve the next page of results. When paginating you can check if those keys exist.

curl https://api.mobiniti.com/v1/groups?limit=2
 {
    "data": [
        {
            "id": "8075886f-5f3e-486a-97ba-9e91829732e1",
            "name": "My test group",
            "join_message": "My new message",
            "one_time_message": false,
            "always_send_join": false,
            "social_profiling": false,
            "email_new_contact": false,
            "created_at": "2014-07-10T00:01:01+0000",
            "updated_at": "2015-06-29T12:40:05+0000",
            "optin": {
                "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
                "name": "Email",
                "description": "Text Email Address to confirm",
                "enabled": true
            }
        },
        {
            "id": "6d9265cc-a310-406d-8f7a-abe015ee561a",
            "name": "My test group 2",
            "join_message": "My new message 2",
            "one_time_message": false,
            "always_send_join": false,
            "social_profiling": false,
            "email_new_contact": false,
            "created_at": "2015-03-16T17:01:43+0000",
            "updated_at": "2015-06-18T14:09:52+0000",
            "optin": {
                "name": "Email",
                "description": "Text Email Address to confirm",
                "enabled": true
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 6,
            "count": 2,
            "per_page": 2,
            "current_page": 1,
            "total_pages": 2,
            "links": {
                "next": "https://api.mobiniti.com/v1/groups?limit=2&page=2"
            }
        }
    }
}

HTTP Methods

This API uses HTTP verbs (methods) as following:

  • GET - Read - used to read (or retrieve) a representation of a resource,

  • POST - Create - used to create new resources. In particular, it's used to create subordinate resources.

  • PUT - Update/Replace - used for update capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource. On successful request, replaces identified resource with the request body.

  • PATCH - Update/Modify - used for modify capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource.

  • DELETE - Delete - used to delete a resource identified by a URI.

Media Type

Where applicable this API MUST use the JSON content-type. Requests with a message-body are using plain JSON to set or update resource states.

Content-type: application/json and Accept: application/json headers SHOULD be set on all requests if not stated otherwise.

Representation of Date and Time

All exchange of date and time-related data MUST be done according to ISO 8601 standard and stored in UTC.

When returning date and time-related data YYYY-MM-DDThh:mm:ss.SSSZ format MUST be used.

Resource IDs

The ‘id’ fields will always be a UUID

Example

f82e541a-a4b1-11e8-a85f-127fd0971098

Status Codes and Errors

The Mobiniti API uses HTTP status codes to communicate with the API consumer.

  • 200 OK - Response to a successful GET, PUT, PATCH or DELETE.

  • 201 Created - Response to a POST that results in a creation.

  • 204 No Content - Response to a successful request that won't be returning a body (like a DELETE request).

  • 400 Bad Request - Malformed request; form validation errors.

  • 401 Unauthorized - When no or invalid authentication details are provided.

  • 402 Payment Required - You need to pay for campaign or contact messages.

  • 403 Forbidden - When authentication succeeded but authenticated user doesn't have access to the resource.

  • 404 Not Found - When a non-existent resource is requested.

  • 405 Method Not Allowed - Method not allowed.

  • 406 Not Acceptable - Could not satisfy the request Accept header.

  • 415 Unsupported Media Type - Unsupported media type in request.

  • 422 Unprocessable Entity - Usually a validation error.

  • 429 Too Many Requests - Rate limit reached.

  • 500 Internal Server Error - An error occurred on our server.

  • 503 Service Unavailable - We’re temporarily offline for maintenance. Please try again later.

  • 504 Gateway Timeout' - A 3rd party service has timed out. Please try again later.

Error response

The Mobiniti API returns both, machine-readable error codes and human-readable error messages in response body when an error is encountered.

Example

Validation Error
{
    "status": 422,
    "message": "A validation error occurred",
    "errors": {
        "phone_number": [
            "The contact already exists."
        ]
    }
}
Generic Error
{
    "status": 400,
    "message": "An error has occurred with your request and is unable to be processed.",
    "errors": {}
}

Request ID's

Each API request has an associated request id. You can find this in the response headers, under X-Request-Id. If you need to contact us regarding a specific request, this id can be helpful for debugging purposes.

Rate Limits

All requests to the API are rate limited to 1 request per second for each route. Each response contains 2 headers that can be used to manage the rate limit.

Header Value
X-RateLimit-Limit 60
X-RateLimit-Remaining 59

If the rate limit is exceeded, a HTTP status code of 429 will be returned.

Contacts

Contacts

Contacts are the subscribers you market to using campaigns and coupons.

GET /contacts List all contacts

Returns a list of contacts that were previously created or joined your list.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Filter Type
phone_number Exact
reward_points Exact
Include Example
carrier /v1/contacts?include=carrier

Example URI

GET https://api.mobiniti.com/v1/contacts

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "first_name": "John",
      "last_name": "Doe",
      "gender": "Male",
      "birth_date": "2005-10-29",
      "phone_number": "9999999999",
      "email": "john.doe@mail.com",
      "reward_points": 0,
      "status": {
        "name": "Confirmed",
        "description": "A contact that has confirmed subscription"
      },
      "groups": {
        "data": [
          {
            "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
            "created_at": "2016-07-01T15:11:09.553Z",
            "updated_at": "2016-07-01T15:11:09.553Z",
            "name": "Group Name",
            "join_message": "Thanks for signing up!",
            "one_time_message": false,
            "always_send_join": false,
            "social_profiling": false,
            "email_new_contact": true,
            "emails": [
              "jon.doe@email.com"
            ],
            "birthday_message": null,
            "optin": {
              "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
              "name": "Email",
              "description": "Text Email Address to confirm",
              "enabled": true
            }
          }
        ]
      },
      "custom_fields": {
        "data": [
          {
            "name": "Account Number",
            "value": "87654321",
            "created_at": "2016-07-01T15:11:09.553Z",
            "updated_at": "2016-07-01T15:11:09.553Z"
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST /contacts Create a contact

To create a new contact within your account, you create a new contact object. Note that a SMS message will be sent to the provided phone number and they must opt-in in order for you to send messages to them.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/contacts

Headers

Content-Type: application/json

Body

{
  "first_name": "John",
  "last_name": "Doe",
  "gender": "Male",
  "birth_date": "2005-10-29",
  "phone_number": "9999999999",
  "email": "john.doe@mail.com",
  "reward_points": 0,
  "groups": [
    "f82e541a-a4b1-11e8-a85f-127fd0971098"
  ],
  "custom_fields": [
    {
      "name": "Account Number",
      "value": "87654321"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "First name of the contact."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Last name of the contact."
    },
    "gender": {
      "type": [
        "string",
        "null"
      ],
      "description": "Gender of the contact."
    },
    "birth_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Birth date of the contact."
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number of the contact."
    },
    "email": {
      "type": "string",
      "description": "Email address of the contact."
    },
    "reward_points": {
      "type": "number",
      "description": "Total reward points the contact has earned."
    },
    "groups": {
      "type": "array",
      "description": "Groups"
    },
    "custom_fields": {
      "type": "array",
      "description": "Custom Fields"
    }
  },
  "required": [
    "phone_number"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "Male",
    "birth_date": "2005-10-29",
    "phone_number": "9999999999",
    "email": "john.doe@mail.com",
    "reward_points": 0,
    "status": {
      "name": "Confirmed",
      "description": "A contact that has confirmed subscription"
    },
    "groups": {
      "data": [
        {
          "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z",
          "name": "Group Name",
          "join_message": "Thanks for signing up!",
          "one_time_message": false,
          "always_send_join": false,
          "social_profiling": false,
          "email_new_contact": true,
          "emails": [
            "jon.doe@email.com"
          ],
          "birthday_message": null,
          "optin": {
            "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
            "name": "Email",
            "description": "Text Email Address to confirm",
            "enabled": true
          }
        }
      ]
    },
    "custom_fields": {
      "data": [
        {
          "name": "Account Number",
          "value": "87654321",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z"
        }
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the contact."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the contact."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "Gender of the contact."
        },
        "birth_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "Birth date of the contact."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address of the contact."
        },
        "reward_points": {
          "type": "number",
          "description": "Total reward points the contact has earned."
        },
        "status": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Current status of contact"
            },
            "description": {
              "type": "string",
              "description": "Contact status description"
            }
          }
        },
        "groups": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        },
        "custom_fields": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        }
      },
      "required": [
        "id",
        "phone_number"
      ]
    }
  }
}

Contact

GET /contacts/{id} Retrieve a contact

Retrieves the details of an existing contact.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Include Example
carrier /v1/contacts?include=carrier

Example URI

GET https://api.mobiniti.com/v1/contacts/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "Male",
    "birth_date": "2005-10-29",
    "phone_number": "9999999999",
    "email": "john.doe@mail.com",
    "reward_points": 0,
    "status": {
      "name": "Confirmed",
      "description": "A contact that has confirmed subscription"
    },
    "groups": {
      "data": [
        {
          "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z",
          "name": "Group Name",
          "join_message": "Thanks for signing up!",
          "one_time_message": false,
          "always_send_join": false,
          "social_profiling": false,
          "email_new_contact": true,
          "emails": [
            "jon.doe@email.com"
          ],
          "birthday_message": null,
          "optin": {
            "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
            "name": "Email",
            "description": "Text Email Address to confirm",
            "enabled": true
          }
        }
      ]
    },
    "custom_fields": {
      "data": [
        {
          "name": "Account Number",
          "value": "87654321",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z"
        }
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the contact."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the contact."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "Gender of the contact."
        },
        "birth_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "Birth date of the contact."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address of the contact."
        },
        "reward_points": {
          "type": "number",
          "description": "Total reward points the contact has earned."
        },
        "status": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Current status of contact"
            },
            "description": {
              "type": "string",
              "description": "Contact status description"
            }
          }
        },
        "groups": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        },
        "custom_fields": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        }
      },
      "required": [
        "id",
        "phone_number"
      ]
    }
  }
}

PUT /contacts/{id} Update a contact

Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged. If you send an empty array of groups, the contact will be removed from all groups. This request accepts only the arguments used in table below, the phone number of a contact cannot be changed.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/contacts/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "first_name": "John",
  "last_name": "Doe",
  "gender": "Male",
  "birth_date": "2005-10-29",
  "email": "john.doe@mail.com",
  "reward_points": 0,
  "groups": [
    "f82e541a-a4b1-11e8-a85f-127fd0971098"
  ],
  "custom_fields": [
    {
      "name": "Account Number",
      "value": "87654321"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "First name of the contact."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Last name of the contact."
    },
    "gender": {
      "type": [
        "string",
        "null"
      ],
      "description": "Gender of the contact."
    },
    "birth_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Birth date of the contact."
    },
    "email": {
      "type": "string",
      "description": "Email address of the contact."
    },
    "reward_points": {
      "type": "number",
      "description": "Total reward points the contact has earned."
    },
    "groups": {
      "type": "array",
      "description": "Groups"
    },
    "custom_fields": {
      "type": "array",
      "description": "Custom Fields"
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "Male",
    "birth_date": "2005-10-29",
    "phone_number": "9999999999",
    "email": "john.doe@mail.com",
    "reward_points": 0,
    "status": {
      "name": "Confirmed",
      "description": "A contact that has confirmed subscription"
    },
    "groups": {
      "data": [
        {
          "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z",
          "name": "Group Name",
          "join_message": "Thanks for signing up!",
          "one_time_message": false,
          "always_send_join": false,
          "social_profiling": false,
          "email_new_contact": true,
          "emails": [
            "jon.doe@email.com"
          ],
          "birthday_message": null,
          "optin": {
            "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
            "name": "Email",
            "description": "Text Email Address to confirm",
            "enabled": true
          }
        }
      ]
    },
    "custom_fields": {
      "data": [
        {
          "name": "Account Number",
          "value": "87654321",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z"
        }
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the contact."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the contact."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "Gender of the contact."
        },
        "birth_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "Birth date of the contact."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address of the contact."
        },
        "reward_points": {
          "type": "number",
          "description": "Total reward points the contact has earned."
        },
        "status": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Current status of contact"
            },
            "description": {
              "type": "string",
              "description": "Contact status description"
            }
          }
        },
        "groups": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        },
        "custom_fields": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        }
      },
      "required": [
        "id",
        "phone_number"
      ]
    }
  }
}

DELETE /contacts/{id} Delete a contact

Delete a contact based on the provided ID.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

DELETE https://api.mobiniti.com/v1/contacts/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "deleted": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "deleted": {
          "type": "boolean",
          "description": "Confirmation the contact was deleted."
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Contact

PATCH /contacts/unsubscribe Unsubscribe contacts

Unsubscribe a batch of up to 100 phone numbers per request.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PATCH https://api.mobiniti.com/v1/contacts/unsubscribe

Headers

Content-Type: application/json

Body

{
  "phone_numbers": [
    "+15709999999"
  ],
  "message": {
    "+15709999999": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "phone_numbers": {
      "type": "array"
    },
    "message": {
      "type": "object",
      "properties": {
        "+15709999999": {
          "type": "boolean",
          "description": "Whether the phone number will be sent a message"
        }
      }
    }
  },
  "required": [
    "phone_numbers"
  ]
}

Headers

Content-Type: application/json

Body

[]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object"
}

Add Groups

POST /contacts/{id}/groups Add a group to a contact

Add a group to the specified contact.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/contacts/f82e541a-a4b1-11e8-a85f-127fd0971098/groups

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "groups": [
    "f82e541a-a4b1-11e8-a85f-127fd0971098"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "description": "Groups"
    }
  },
  "required": [
    "groups"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "Male",
    "birth_date": "2005-10-29",
    "phone_number": "9999999999",
    "email": "john.doe@mail.com",
    "reward_points": 0,
    "status": {
      "name": "Confirmed",
      "description": "A contact that has confirmed subscription"
    },
    "groups": {
      "data": [
        {
          "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z",
          "name": "Group Name",
          "join_message": "Thanks for signing up!",
          "one_time_message": false,
          "always_send_join": false,
          "social_profiling": false,
          "email_new_contact": true,
          "emails": [
            "jon.doe@email.com"
          ],
          "birthday_message": null,
          "optin": {
            "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
            "name": "Email",
            "description": "Text Email Address to confirm",
            "enabled": true
          }
        }
      ]
    },
    "custom_fields": {
      "data": [
        {
          "name": "Account Number",
          "value": "87654321",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z"
        }
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the contact."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the contact."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "Gender of the contact."
        },
        "birth_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "Birth date of the contact."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address of the contact."
        },
        "reward_points": {
          "type": "number",
          "description": "Total reward points the contact has earned."
        },
        "status": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Current status of contact"
            },
            "description": {
              "type": "string",
              "description": "Contact status description"
            }
          }
        },
        "groups": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        },
        "custom_fields": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        }
      },
      "required": [
        "id",
        "phone_number"
      ]
    }
  }
}

Remove Group

DELETE /contacts/{id}/groups/{group} Remove group from contact

Remove a group from the specified contact.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

DELETE https://api.mobiniti.com/v1/contacts/f82e541a-a4b1-11e8-a85f-127fd0971098/groups/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.
group

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "Male",
    "birth_date": "2005-10-29",
    "phone_number": "9999999999",
    "email": "john.doe@mail.com",
    "reward_points": 0,
    "status": {
      "name": "Confirmed",
      "description": "A contact that has confirmed subscription"
    },
    "groups": {
      "data": [
        {
          "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z",
          "name": "Group Name",
          "join_message": "Thanks for signing up!",
          "one_time_message": false,
          "always_send_join": false,
          "social_profiling": false,
          "email_new_contact": true,
          "emails": [
            "jon.doe@email.com"
          ],
          "birthday_message": null,
          "optin": {
            "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
            "name": "Email",
            "description": "Text Email Address to confirm",
            "enabled": true
          }
        }
      ]
    },
    "custom_fields": {
      "data": [
        {
          "name": "Account Number",
          "value": "87654321",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z"
        }
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the contact."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the contact."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "Gender of the contact."
        },
        "birth_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "Birth date of the contact."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address of the contact."
        },
        "reward_points": {
          "type": "number",
          "description": "Total reward points the contact has earned."
        },
        "status": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Current status of contact"
            },
            "description": {
              "type": "string",
              "description": "Contact status description"
            }
          }
        },
        "groups": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        },
        "custom_fields": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        }
      },
      "required": [
        "id",
        "phone_number"
      ]
    }
  }
}

Carriers

Carriers

Carrier are the network that contacts are on.

GET /carriers List all carriers

Returns a list of carriers.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/carriers

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "name": "Verizon Wireless"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

Carrier

GET /carriers/{id} Retrieve a carrier

Retrieves the details of a carrier.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/carriers/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Verizon Wireless"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the carrier."
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Groups

Groups

Groups are used to organize contacts.

GET /groups List all groups

Returns a list of groups you’ve previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Include Details
keyword If a keyword exists on the group it will be an object, otherwise it will be null.

Example URI

GET https://api.mobiniti.com/v1/groups

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "name": "Group Name",
      "join_message": "Thanks for signing up!",
      "one_time_message": false,
      "always_send_join": false,
      "social_profiling": false,
      "email_new_contact": true,
      "emails": [
        "jon.doe@email.com"
      ],
      "birthday_message": null,
      "optin": {
        "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
        "name": "Email",
        "description": "Text Email Address to confirm",
        "enabled": true
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST /groups Create a group

To create a new group to organize your contacts, you create a new group object. Allows optional creation of a keyword allowing contacts to text that keyword to join the group.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/groups

Headers

Content-Type: application/json

Body

{
  "name": "My test group",
  "join_message": "Thanks for signing up!",
  "optin": true,
  "optin_type": "8524a66e-39df-4d67-933f-6f7534767af9",
  "keyword": {
    "name": "TEST",
    "phone_number": "19999999999"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Name of the group."
    },
    "join_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Message a contact receives after signing up."
    },
    "optin": {
      "type": "boolean",
      "description": "Set to true to enable optin's for the group."
    },
    "optin_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Set the type of opt-in the group will use."
    },
    "keyword": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Set the keyword name"
        },
        "phone_number": {
          "type": "string",
          "description": "The phone number the keyword will be attached to. Must be available on your account."
        }
      }
    }
  },
  "required": [
    "name"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Group Name",
    "join_message": "Thanks for signing up!",
    "one_time_message": false,
    "always_send_join": false,
    "social_profiling": false,
    "email_new_contact": true,
    "emails": [
      "jon.doe@email.com"
    ],
    "birthday_message": null,
    "optin": {
      "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
      "name": "Email",
      "description": "Text Email Address to confirm",
      "enabled": true
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "Name of the group."
        },
        "join_message": {
          "type": "string",
          "description": "Message a contact receives after signing up."
        },
        "one_time_message": {
          "type": "boolean",
          "description": "Set if the group uses a one time message"
        },
        "always_send_join": {
          "type": "boolean",
          "description": "Set if the join message should always be sent"
        },
        "social_profiling": {
          "type": "boolean",
          "description": "Set if social profiling is enabled"
        },
        "email_new_contact": {
          "type": "boolean",
          "description": "Set if the an email is sent for each new contact that joins the group"
        },
        "emails": {
          "type": "array",
          "description": "Set the email addresses that the new contact email will be sent to"
        },
        "birthday_message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Set the birthday message for the birth date opt-in"
        },
        "optin": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "4e4b3bda-e68b-4981-a5c6-2ddffd52d059"
              ],
              "description": "unique uuid."
            },
            "name": {
              "type": "string",
              "description": "Name of the opt-in"
            },
            "description": {
              "type": "string",
              "description": "Description of the opt-in"
            },
            "enabled": {
              "type": "boolean",
              "description": "Whether the opt-in is enabled"
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  }
}

Group

GET /groups/{id} Retrieve a group

Retrieves the details of a group that was previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Include Details
keyword If a keyword exists on the group it will be an object, otherwise it will be null.

Example URI

GET https://api.mobiniti.com/v1/groups/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Group Name",
    "join_message": "Thanks for signing up!",
    "one_time_message": false,
    "always_send_join": false,
    "social_profiling": false,
    "email_new_contact": true,
    "emails": [
      "jon.doe@email.com"
    ],
    "birthday_message": null,
    "optin": {
      "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
      "name": "Email",
      "description": "Text Email Address to confirm",
      "enabled": true
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "Name of the group."
        },
        "join_message": {
          "type": "string",
          "description": "Message a contact receives after signing up."
        },
        "one_time_message": {
          "type": "boolean",
          "description": "Set if the group uses a one time message"
        },
        "always_send_join": {
          "type": "boolean",
          "description": "Set if the join message should always be sent"
        },
        "social_profiling": {
          "type": "boolean",
          "description": "Set if social profiling is enabled"
        },
        "email_new_contact": {
          "type": "boolean",
          "description": "Set if the an email is sent for each new contact that joins the group"
        },
        "emails": {
          "type": "array",
          "description": "Set the email addresses that the new contact email will be sent to"
        },
        "birthday_message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Set the birthday message for the birth date opt-in"
        },
        "optin": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "4e4b3bda-e68b-4981-a5c6-2ddffd52d059"
              ],
              "description": "unique uuid."
            },
            "name": {
              "type": "string",
              "description": "Name of the opt-in"
            },
            "description": {
              "type": "string",
              "description": "Description of the opt-in"
            },
            "enabled": {
              "type": "boolean",
              "description": "Whether the opt-in is enabled"
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  }
}

PUT /groups/{id} Update a group

Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/groups/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "name": "My test group",
  "join_message": "Thanks for signing up!",
  "one_time_message": false,
  "always_send_join": false,
  "social_profiling": false,
  "email_new_contact": true,
  "emails": [
    "jon.doe@email.com"
  ],
  "optin": true,
  "optin_type": "8524a66e-39df-4d67-933f-6f7534767af9",
  "birthday_message": null
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the group."
    },
    "join_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Message a contact receives after signing up."
    },
    "one_time_message": {
      "type": "boolean",
      "description": "Update if the group uses a one time message"
    },
    "always_send_join": {
      "type": "boolean",
      "description": "Update whether the group should always send the join message"
    },
    "social_profiling": {
      "type": "boolean",
      "description": "Update whether social profiling is enabled on the group"
    },
    "email_new_contact": {
      "type": "boolean",
      "description": "Update whether emails should be sent for each new contact"
    },
    "emails": {
      "type": "array",
      "description": "Update the email addresses that the new contact email will be sent to. Any emails in the array will be used. Any emails for the group not included in the array will be deleted"
    },
    "optin": {
      "type": "boolean",
      "description": "Set to true to enable optin's for the group."
    },
    "optin_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Set the type of opt-in the group will use."
    },
    "birthday_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Update the birthday message for the birth date opt-in"
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Group Name",
    "join_message": "Thanks for signing up!",
    "one_time_message": false,
    "always_send_join": false,
    "social_profiling": false,
    "email_new_contact": true,
    "emails": [
      "jon.doe@email.com"
    ],
    "birthday_message": null,
    "optin": {
      "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
      "name": "Email",
      "description": "Text Email Address to confirm",
      "enabled": true
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "Name of the group."
        },
        "join_message": {
          "type": "string",
          "description": "Message a contact receives after signing up."
        },
        "one_time_message": {
          "type": "boolean",
          "description": "Set if the group uses a one time message"
        },
        "always_send_join": {
          "type": "boolean",
          "description": "Set if the join message should always be sent"
        },
        "social_profiling": {
          "type": "boolean",
          "description": "Set if social profiling is enabled"
        },
        "email_new_contact": {
          "type": "boolean",
          "description": "Set if the an email is sent for each new contact that joins the group"
        },
        "emails": {
          "type": "array",
          "description": "Set the email addresses that the new contact email will be sent to"
        },
        "birthday_message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Set the birthday message for the birth date opt-in"
        },
        "optin": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "4e4b3bda-e68b-4981-a5c6-2ddffd52d059"
              ],
              "description": "unique uuid."
            },
            "name": {
              "type": "string",
              "description": "Name of the opt-in"
            },
            "description": {
              "type": "string",
              "description": "Description of the opt-in"
            },
            "enabled": {
              "type": "boolean",
              "description": "Whether the opt-in is enabled"
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  }
}

Group Contacts

GET /groups/{id}/contacts Retrieve a group contacts

Retrieves the contacts of a group.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Filter Type
phone_number Exact
reward_points Exact
Include
status
groups
fields

Example URI

GET https://api.mobiniti.com/v1/groups/f82e541a-a4b1-11e8-a85f-127fd0971098/contacts

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "Male",
    "birth_date": "2005-10-29",
    "phone_number": "9999999999",
    "email": "john.doe@mail.com",
    "reward_points": 0,
    "status": {
      "name": "Confirmed",
      "description": "A contact that has confirmed subscription"
    },
    "groups": {
      "data": [
        {
          "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z",
          "name": "Group Name",
          "join_message": "Thanks for signing up!",
          "one_time_message": false,
          "always_send_join": false,
          "social_profiling": false,
          "email_new_contact": true,
          "emails": [
            "jon.doe@email.com"
          ],
          "birthday_message": null,
          "optin": {
            "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
            "name": "Email",
            "description": "Text Email Address to confirm",
            "enabled": true
          }
        }
      ]
    },
    "custom_fields": {
      "data": [
        {
          "name": "Account Number",
          "value": "87654321",
          "created_at": "2016-07-01T15:11:09.553Z",
          "updated_at": "2016-07-01T15:11:09.553Z"
        }
      ]
    }
  },
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the contact."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the contact."
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "description": "Gender of the contact."
        },
        "birth_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "Birth date of the contact."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address of the contact."
        },
        "reward_points": {
          "type": "number",
          "description": "Total reward points the contact has earned."
        },
        "status": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Current status of contact"
            },
            "description": {
              "type": "string",
              "description": "Contact status description"
            }
          }
        },
        "groups": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        },
        "custom_fields": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array"
            }
          }
        }
      },
      "required": [
        "id",
        "phone_number"
      ]
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

Opt-in's

Opt-ins are used to confirm subscribers allow you to send them messages. They can also be used to collect subscriber data such as email addresses which can help you market to them further.

Opt-ins

GET /opt-ins List all opt-in's

Returns a list of opt-ins.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/opt-ins

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
      "name": "Email",
      "description": "Text Email Address to confirm",
      "enabled": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

Opt-in

GET /opt-ins/{id} Retrieve an opt-in

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/opt-ins/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
    "name": "Email",
    "description": "Text Email Address to confirm",
    "enabled": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "4e4b3bda-e68b-4981-a5c6-2ddffd52d059"
          ],
          "description": "unique uuid."
        },
        "name": {
          "type": "string",
          "description": "Name of the opt-in"
        },
        "description": {
          "type": "string",
          "description": "Description of the opt-in"
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether the opt-in is enabled"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Campaigns

Campaigns are an easy way to help maintain brand loyalty, inform your contacts of what’s happening with your business or send promotional offers.

Campaigns

GET /campaigns List all campaigns

Returns a list of campaigns that were previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/campaigns

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "name": "Example campaign name",
      "to": [
        "f82e541a-a4b1-11e8-a85f-127fd0971098"
      ],
      "message": "This is an example message",
      "message_pending_contacts": false,
      "send_date": "2016-07-01T15:11:09.553Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST /campaigns Create a campaign

Create a campaign to market to your contacts.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/campaigns

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "name": "Example campaign name",
  "to": [
    "f82e541a-a4b1-11e8-a85f-127fd0971098"
  ],
  "message": "This is an example message",
  "message_pending_contacts": false,
  "send_date": "2025-12-31T17:11:09-04:00",
  "enable_short_links": true,
  "unique_short_links": true,
  "exclude_groups": "'g82e541a"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the campaign for your own reference."
    },
    "to": {
      "type": "array",
      "description": "The recipients of the message. Use -1 to send to all contacts, otherwise specify the group id’s."
    },
    "message": {
      "type": "string",
      "description": "The message to be sent to the specified recipients."
    },
    "message_pending_contacts": {
      "type": "boolean",
      "description": "Whether the campaign is sent to pending contacts."
    },
    "send_date": {
      "type": "string",
      "description": "Date the campaign should be sent. If no date is supplied it is sent immediately."
    },
    "enable_short_links": {
      "type": "boolean",
      "description": "Whether links should be shortened."
    },
    "unique_short_links": {
      "type": "boolean",
      "description": "Whether short links should be unique for each contact."
    },
    "exclude_groups": {
      "type": "string",
      "description": "a4b1-11e8-a85f-127fd0971099' (array, optional) - UUIDs of message groups whose members will not receive messages. Send an empty array to remove all entries."
    }
  },
  "required": [
    "name",
    "to",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Example campaign name",
    "to": [
      "f82e541a-a4b1-11e8-a85f-127fd0971098"
    ],
    "message": "This is an example message",
    "message_pending_contacts": false,
    "send_date": "2016-07-01T15:11:09.553Z"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the campaign for your own reference."
        },
        "to": {
          "type": "array",
          "description": "The recipients of the message. Use -1 to send to all contacts, otherwise specify the group id’s."
        },
        "message": {
          "type": "string",
          "description": "The message to be sent to the specified recipients."
        },
        "message_pending_contacts": {
          "type": "boolean",
          "description": "Whether the campaign is sent to pending contacts."
        },
        "send_date": {
          "type": "string",
          "description": "Schedule the campaign for a future date. If not specified it will be sent immediately."
        }
      },
      "required": [
        "id",
        "name",
        "to",
        "message"
      ]
    }
  }
}

Campaign

GET /campaigns/{id} Retrieve a campaign

Retrieves the details of a campaign that was previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/campaigns/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Example campaign name",
    "to": [
      "f82e541a-a4b1-11e8-a85f-127fd0971098"
    ],
    "message": "This is an example message",
    "message_pending_contacts": false,
    "send_date": "2016-07-01T15:11:09.553Z"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the campaign for your own reference."
        },
        "to": {
          "type": "array",
          "description": "The recipients of the message. Use -1 to send to all contacts, otherwise specify the group id’s."
        },
        "message": {
          "type": "string",
          "description": "The message to be sent to the specified recipients."
        },
        "message_pending_contacts": {
          "type": "boolean",
          "description": "Whether the campaign is sent to pending contacts."
        },
        "send_date": {
          "type": "string",
          "description": "Schedule the campaign for a future date. If not specified it will be sent immediately."
        }
      },
      "required": [
        "id",
        "name",
        "to",
        "message"
      ]
    }
  }
}

PUT /campaigns/{id} Update a campaign

Updates the specified campaign by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/campaigns/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "name": "Example campaign name",
  "to": [
    "f82e541a-a4b1-11e8-a85f-127fd0971098"
  ],
  "message": "This is an example message",
  "message_pending_contacts": false,
  "send_date": "2016-07-01T15:11:09.553Z",
  "enable_short_links": true,
  "unique_short_links": true,
  "exclude_groups": "'g82e541a"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the campaign for your own reference."
    },
    "to": {
      "type": "array",
      "description": "The recipients of the message. Use -1 to send to all contacts, otherwise specify the group id’s."
    },
    "message": {
      "type": "string",
      "description": "The message to be sent to the specified recipients."
    },
    "message_pending_contacts": {
      "type": "boolean",
      "description": "Whether the campaign is sent to pending contacts."
    },
    "send_date": {
      "type": "string",
      "description": "Date the campaign should be sent. If no date is supplied it is sent immediately."
    },
    "enable_short_links": {
      "type": "boolean",
      "description": "Whether links should be shortened."
    },
    "unique_short_links": {
      "type": "boolean",
      "description": "Whether short links should be unique for each contact."
    },
    "exclude_groups": {
      "type": "string",
      "description": "a4b1-11e8-a85f-127fd0971099' (array, optional) - UUIDs of message groups whose members will not receive messages. Send an empty array to remove all entries."
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Example campaign name",
    "to": [
      "f82e541a-a4b1-11e8-a85f-127fd0971098"
    ],
    "message": "This is an example message",
    "message_pending_contacts": false,
    "send_date": "2016-07-01T15:11:09.553Z"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the campaign for your own reference."
        },
        "to": {
          "type": "array",
          "description": "The recipients of the message. Use -1 to send to all contacts, otherwise specify the group id’s."
        },
        "message": {
          "type": "string",
          "description": "The message to be sent to the specified recipients."
        },
        "message_pending_contacts": {
          "type": "boolean",
          "description": "Whether the campaign is sent to pending contacts."
        },
        "send_date": {
          "type": "string",
          "description": "Schedule the campaign for a future date. If not specified it will be sent immediately."
        }
      },
      "required": [
        "id",
        "name",
        "to",
        "message"
      ]
    }
  }
}

DELETE /campaigns/{id} Delete a campaign

You can delete a campaign only if it has not yet been sent or is in the process of sending.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

DELETE https://api.mobiniti.com/v1/campaigns/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "deleted": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "deleted": {
          "type": "boolean",
          "description": "Confirmation the campaign was deleted."
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Campaign templates

Campaign templates are an easy way to easily create new campaigns for common messages that you send to your contacts.

Campaign Templates

GET /campaigns/templates List all campaign templates

Returns a list of campaign templates that were previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/campaigns/templates

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "name": "Template 1",
      "message": "This is an example template message",
      "first_name_default": "First name",
      "last_name_default": "Last name",
      "active": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST /campaigns/templates Create a campaign template

Create a campaign template.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/campaigns/templates

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "name": "Template 1",
  "message": "This is an example template message",
  "first_name_default": "First name",
  "last_name_default": "Last name",
  "active": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the template for your own reference."
    },
    "message": {
      "type": "string",
      "description": "The message to be used when creating a new campaign."
    },
    "first_name_default": {
      "type": "string",
      "description": "Default value for first name field if none is available."
    },
    "last_name_default": {
      "type": "string",
      "description": "Default value for the last name field if none is available."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the template is currently active"
    }
  },
  "required": [
    "name",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Template 1",
    "message": "This is an example template message",
    "first_name_default": "First name",
    "last_name_default": "Last name",
    "active": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the template for your own reference."
        },
        "message": {
          "type": "string",
          "description": "The message to be used when creating a new campaign."
        },
        "first_name_default": {
          "type": "string",
          "description": "Default value for first name field if none is available."
        },
        "last_name_default": {
          "type": "string",
          "description": "Default value for the last name field if none is available."
        },
        "active": {
          "type": "boolean",
          "description": "Whether the template is currently active"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Campaign Template

GET /campaigns/templates/{id} Retrieve a campaign template

Retrieves the details of a campaign template that was previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/campaigns/templates/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Template 1",
    "message": "This is an example template message",
    "first_name_default": "First name",
    "last_name_default": "Last name",
    "active": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the template for your own reference."
        },
        "message": {
          "type": "string",
          "description": "The message to be used when creating a new campaign."
        },
        "first_name_default": {
          "type": "string",
          "description": "Default value for first name field if none is available."
        },
        "last_name_default": {
          "type": "string",
          "description": "Default value for the last name field if none is available."
        },
        "active": {
          "type": "boolean",
          "description": "Whether the template is currently active"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

PUT /campaigns/templates/{id} Update a campaign

Updates the specified campaign template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/campaigns/templates/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "name": "Template 1",
  "message": "This is an example template message",
  "first_name_default": "First name",
  "last_name_default": "Last name",
  "active": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the template for your own reference."
    },
    "message": {
      "type": "string",
      "description": "The message to be used when creating a new campaign."
    },
    "first_name_default": {
      "type": "string",
      "description": "Default value for first name field if none is available."
    },
    "last_name_default": {
      "type": "string",
      "description": "Default value for the last name field if none is available."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the template is currently active"
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "Template 1",
    "message": "This is an example template message",
    "first_name_default": "First name",
    "last_name_default": "Last name",
    "active": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the template for your own reference."
        },
        "message": {
          "type": "string",
          "description": "The message to be used when creating a new campaign."
        },
        "first_name_default": {
          "type": "string",
          "description": "Default value for first name field if none is available."
        },
        "last_name_default": {
          "type": "string",
          "description": "Default value for the last name field if none is available."
        },
        "active": {
          "type": "boolean",
          "description": "Whether the template is currently active"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

DELETE /campaigns/templates/{id} Delete a campaign

Delete a campaign template.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

DELETE https://api.mobiniti.com/v1/campaigns/templates/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "deleted": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "deleted": {
          "type": "boolean",
          "description": "Confirmation the campaign template was deleted."
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Coupons

Coupons are a great way to entice customers to come back to your establishment. They can also be used as an incentive for customers to join your list.

Coupons

GET /coupons List all coupons

Returns a list of coupons that were previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/coupons

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "name": "March Coupon",
      "offer": "Green clothing half off",
      "start": "2016-07-01T15:11:09.553Z",
      "end": "2016-07-01T15:11:09.553Z",
      "max_redemptions": 1,
      "upc": "123456789",
      "terms": "My terms",
      "mobile_wallets": true,
      "accent_color": "#ff00ff",
      "company_name": "My Company",
      "phone_number": "+13337774444",
      "address1": "999 Yellow Brick Lane",
      "address2": "Suite 2",
      "template": {
        "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
        "name": "Modern",
        "description": null
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST /coupons Create a coupon

Create a coupon that can be sent to contacts.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/coupons

Headers

Content-Type: application/json

Body

{
  "template_id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
  "name": "March Coupon",
  "offer": "Green clothing half off",
  "start": "2016-07-01T15:11:09.553Z",
  "end": "2016-07-01T15:11:09.553Z",
  "max_redemptions": 1,
  "upc": "123456789",
  "terms": "My terms",
  "mobile_wallets": true,
  "accent_color": "#ff00ff",
  "company_name": "My Company",
  "phone_number": "+13337774444",
  "address1": "999 Yellow Brick Lane",
  "address2": "Suite 2"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "unique uuid."
    },
    "name": {
      "type": "string",
      "description": "The name of the coupon for your reference."
    },
    "offer": {
      "type": "string",
      "description": "The offer for the coupon."
    },
    "start": {
      "type": "string",
      "description": "The date the offer will start (ISO-8601 format)."
    },
    "end": {
      "type": "string",
      "description": "The date the offer will end (ISO-8601 format)."
    },
    "max_redemptions": {
      "type": "number",
      "description": "Maximum number of redemptions per contact, 0 for unlimited."
    },
    "upc": {
      "type": "string",
      "description": "The upc code that will be associated to this coupon."
    },
    "terms": {
      "type": "string",
      "description": "The terms and conditions of the coupon."
    },
    "mobile_wallets": {
      "type": "boolean",
      "description": "Whether to use mobile wallets for this coupon."
    },
    "accent_color": {
      "type": "string",
      "description": "The accent color of the coupon."
    },
    "company_name": {
      "type": "string",
      "description": "The name of the company for this coupon."
    },
    "phone_number": {
      "type": "string",
      "description": "The phone number of your company."
    },
    "address1": {
      "type": "string",
      "description": "The address of your company."
    },
    "address2": {
      "type": "string",
      "description": "The second line of your company address."
    }
  },
  "required": [
    "template_id",
    "name",
    "offer",
    "upc"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "March Coupon",
    "offer": "Green clothing half off",
    "start": "2016-07-01T15:11:09.553Z",
    "end": "2016-07-01T15:11:09.553Z",
    "max_redemptions": 1,
    "upc": "123456789",
    "terms": "My terms",
    "mobile_wallets": true,
    "accent_color": "#ff00ff",
    "company_name": "My Company",
    "phone_number": "+13337774444",
    "address1": "999 Yellow Brick Lane",
    "address2": "Suite 2",
    "template": {
      "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
      "name": "Modern",
      "description": null
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the coupon for your reference."
        },
        "offer": {
          "type": "string",
          "description": "The offer for the coupon."
        },
        "start": {
          "type": "string",
          "description": "The date the offer will start (ISO-8601 format)."
        },
        "end": {
          "type": "string",
          "description": "The date the offer will end (ISO-8601 format)."
        },
        "max_redemptions": {
          "type": "number",
          "description": "Maximum number of redemptions per contact, 0 for unlimited."
        },
        "upc": {
          "type": "string",
          "description": "The upc code that will be associated to this coupon."
        },
        "terms": {
          "type": "string",
          "description": "The terms and conditions of the coupon."
        },
        "mobile_wallets": {
          "type": "boolean",
          "description": "Whether to use mobile wallets for this coupon."
        },
        "accent_color": {
          "type": "string",
          "description": "The accent color of the coupon."
        },
        "company_name": {
          "type": "string",
          "description": "The name of the company for this coupon."
        },
        "phone_number": {
          "type": "string",
          "description": "The phone number of your company."
        },
        "address1": {
          "type": "string",
          "description": "The address of your company."
        },
        "address2": {
          "type": "string",
          "description": "The second line of your company address."
        },
        "template": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148"
              ],
              "description": "unique uuid."
            },
            "name": {
              "type": "string",
              "description": "Name of the opt-in"
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "Description of the opt-in"
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Coupon

GET /coupons/{id} Retrieve a coupon

Retrieves the details of a coupon that was previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/coupons/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "March Coupon",
    "offer": "Green clothing half off",
    "start": "2016-07-01T15:11:09.553Z",
    "end": "2016-07-01T15:11:09.553Z",
    "max_redemptions": 1,
    "upc": "123456789",
    "terms": "My terms",
    "mobile_wallets": true,
    "accent_color": "#ff00ff",
    "company_name": "My Company",
    "phone_number": "+13337774444",
    "address1": "999 Yellow Brick Lane",
    "address2": "Suite 2",
    "template": {
      "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
      "name": "Modern",
      "description": null
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the coupon for your reference."
        },
        "offer": {
          "type": "string",
          "description": "The offer for the coupon."
        },
        "start": {
          "type": "string",
          "description": "The date the offer will start (ISO-8601 format)."
        },
        "end": {
          "type": "string",
          "description": "The date the offer will end (ISO-8601 format)."
        },
        "max_redemptions": {
          "type": "number",
          "description": "Maximum number of redemptions per contact, 0 for unlimited."
        },
        "upc": {
          "type": "string",
          "description": "The upc code that will be associated to this coupon."
        },
        "terms": {
          "type": "string",
          "description": "The terms and conditions of the coupon."
        },
        "mobile_wallets": {
          "type": "boolean",
          "description": "Whether to use mobile wallets for this coupon."
        },
        "accent_color": {
          "type": "string",
          "description": "The accent color of the coupon."
        },
        "company_name": {
          "type": "string",
          "description": "The name of the company for this coupon."
        },
        "phone_number": {
          "type": "string",
          "description": "The phone number of your company."
        },
        "address1": {
          "type": "string",
          "description": "The address of your company."
        },
        "address2": {
          "type": "string",
          "description": "The second line of your company address."
        },
        "template": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148"
              ],
              "description": "unique uuid."
            },
            "name": {
              "type": "string",
              "description": "Name of the opt-in"
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "Description of the opt-in"
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

PUT /coupons/{id} Update a coupon

Updates the specified coupon by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/coupons/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "template_id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
  "name": "March Coupon",
  "offer": "Green clothing half off",
  "start": "2016-07-01T15:11:09.553Z",
  "end": "2016-07-01T15:11:09.553Z",
  "max_redemptions": 1,
  "upc": "123456789",
  "terms": "My terms",
  "mobile_wallets": true,
  "accent_color": "#ff00ff",
  "company_name": "My Company",
  "phone_number": "+13337774444",
  "address1": "999 Yellow Brick Lane",
  "address2": "Suite 2"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "unique uuid."
    },
    "name": {
      "type": "string",
      "description": "The name of the coupon for your reference."
    },
    "offer": {
      "type": "string",
      "description": "The offer for the coupon."
    },
    "start": {
      "type": "string",
      "description": "The date the offer will start (ISO-8601 format)."
    },
    "end": {
      "type": "string",
      "description": "The date the offer will end (ISO-8601 format)."
    },
    "max_redemptions": {
      "type": "number",
      "description": "Maximum number of redemptions per contact, 0 for unlimited."
    },
    "upc": {
      "type": "string",
      "description": "The upc code that will be associated to this coupon."
    },
    "terms": {
      "type": "string",
      "description": "The terms and conditions of the coupon."
    },
    "mobile_wallets": {
      "type": "boolean",
      "description": "Whether to use mobile wallets for this coupon."
    },
    "accent_color": {
      "type": "string",
      "description": "The accent color of the coupon."
    },
    "company_name": {
      "type": "string",
      "description": "The name of the company for this coupon."
    },
    "phone_number": {
      "type": "string",
      "description": "The phone number of your company."
    },
    "address1": {
      "type": "string",
      "description": "The address of your company."
    },
    "address2": {
      "type": "string",
      "description": "The second line of your company address."
    }
  },
  "required": [
    "template_id"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "name": "March Coupon",
    "offer": "Green clothing half off",
    "start": "2016-07-01T15:11:09.553Z",
    "end": "2016-07-01T15:11:09.553Z",
    "max_redemptions": 1,
    "upc": "123456789",
    "terms": "My terms",
    "mobile_wallets": true,
    "accent_color": "#ff00ff",
    "company_name": "My Company",
    "phone_number": "+13337774444",
    "address1": "999 Yellow Brick Lane",
    "address2": "Suite 2",
    "template": {
      "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
      "name": "Modern",
      "description": null
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the coupon for your reference."
        },
        "offer": {
          "type": "string",
          "description": "The offer for the coupon."
        },
        "start": {
          "type": "string",
          "description": "The date the offer will start (ISO-8601 format)."
        },
        "end": {
          "type": "string",
          "description": "The date the offer will end (ISO-8601 format)."
        },
        "max_redemptions": {
          "type": "number",
          "description": "Maximum number of redemptions per contact, 0 for unlimited."
        },
        "upc": {
          "type": "string",
          "description": "The upc code that will be associated to this coupon."
        },
        "terms": {
          "type": "string",
          "description": "The terms and conditions of the coupon."
        },
        "mobile_wallets": {
          "type": "boolean",
          "description": "Whether to use mobile wallets for this coupon."
        },
        "accent_color": {
          "type": "string",
          "description": "The accent color of the coupon."
        },
        "company_name": {
          "type": "string",
          "description": "The name of the company for this coupon."
        },
        "phone_number": {
          "type": "string",
          "description": "The phone number of your company."
        },
        "address1": {
          "type": "string",
          "description": "The address of your company."
        },
        "address2": {
          "type": "string",
          "description": "The second line of your company address."
        },
        "template": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148"
              ],
              "description": "unique uuid."
            },
            "name": {
              "type": "string",
              "description": "Name of the opt-in"
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "Description of the opt-in"
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

DELETE /coupons/{id} Delete a coupon

Delete a coupon.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

DELETE https://api.mobiniti.com/v1/coupons/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "deleted": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "deleted": {
          "type": "boolean",
          "description": "Confirmation the coupon was deleted."
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Coupon Templates

Coupon templates are used to define a coupon’s style and design.

Coupon Templates

GET /coupon_templates List all coupon templates

Returns a list of coupon templates that were previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/coupon_templates

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
      "name": "Modern",
      "description": null
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

Coupon Template

GET /coupon_templates/{id} Retrieve a coupon template

Retrieves the details of a coupon template that was previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/coupon_templates/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
    "name": "Modern",
    "description": null
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148"
          ],
          "description": "unique uuid."
        },
        "name": {
          "type": "string",
          "description": "Name of the opt-in"
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Description of the opt-in"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Messages

Messages that have been sent to and from your account.

Messages

GET /messages List all messages

Returns a list of messages that were sent or received.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Filter Type Value(s)
type Exact unknown, INCOMING_ALL, OUTGOING_ALL
phone_number partial
created_at_min DateTime ISO 8601 DateTime String
created_at_max DateTime ISO 8601 DateTime String
Include Example
receipt /v1/messages?include=receipt
contact.carrier /v1/messages?include=contact.carrier
type /v1/messages?include=type
Combined /v1/messages?include=receipt,contact.carrier, type

Example URI

GET https://api.mobiniti.com/v1/messages

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "message": "This is an example message",
      "read": true,
      "contact": {
        "first_name": "John",
        "last_name": "Doe",
        "gender": "Male",
        "birth_date": "2005-10-29",
        "phone_number": "9999999999",
        "email": "john.doe@mail.com",
        "reward_points": 0
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

Message

GET /messages/{id} Retrieve a message

Retrieves the details of a message that was sent or received.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes
Include Example
receipt /v1/messages?include=receipt
contact.carrier /v1/messages?include=contact.carrier
Combined /v1/messages?include=receipt,contact.carrier

Example URI

GET https://api.mobiniti.com/v1/messages/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "message": "This is an example message",
    "read": true,
    "contact": {
      "first_name": "John",
      "last_name": "Doe",
      "gender": "Male",
      "birth_date": "2005-10-29",
      "phone_number": "9999999999",
      "email": "john.doe@mail.com",
      "reward_points": 0
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "message": {
          "type": "string",
          "description": "Message that was sent or received."
        },
        "read": {
          "type": "boolean",
          "description": "Whether the message has been viewed."
        },
        "contact": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "First name of the contact."
            },
            "last_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Last name of the contact."
            },
            "gender": {
              "type": [
                "string",
                "null"
              ],
              "description": "Gender of the contact."
            },
            "birth_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "Birth date of the contact."
            },
            "phone_number": {
              "type": "string",
              "description": "Phone number of the contact."
            },
            "email": {
              "type": "string",
              "description": "Email address of the contact."
            },
            "reward_points": {
              "type": "number",
              "description": "Total reward points the contact has earned."
            }
          },
          "required": [
            "phone_number"
          ]
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

PUT /messages/{id} Update a message

Updates the specified message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/messages/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "read": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "read": {
      "type": "boolean",
      "description": "Whether the message is read or unread."
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "message": "This is an example message",
    "read": true,
    "contact": {
      "first_name": "John",
      "last_name": "Doe",
      "gender": "Male",
      "birth_date": "2005-10-29",
      "phone_number": "9999999999",
      "email": "john.doe@mail.com",
      "reward_points": 0
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "message": {
          "type": "string",
          "description": "Message that was sent or received."
        },
        "read": {
          "type": "boolean",
          "description": "Whether the message has been viewed."
        },
        "contact": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "First name of the contact."
            },
            "last_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Last name of the contact."
            },
            "gender": {
              "type": [
                "string",
                "null"
              ],
              "description": "Gender of the contact."
            },
            "birth_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "Birth date of the contact."
            },
            "phone_number": {
              "type": "string",
              "description": "Phone number of the contact."
            },
            "email": {
              "type": "string",
              "description": "Email address of the contact."
            },
            "reward_points": {
              "type": "number",
              "description": "Total reward points the contact has earned."
            }
          },
          "required": [
            "phone_number"
          ]
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Messages

POST /messages Send an individual message to a contact

Send 1 message to 1 contact.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/messages

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "contact_id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
  "message": "Example message",
  "metadata": {
    "my_id": "123"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "contact_id": {
      "type": "string",
      "description": "unique uuid."
    },
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "metadata": {
      "type": "object",
      "properties": {
        "my_id": {
          "type": "string",
          "description": "unique uuid."
        }
      },
      "required": [
        "my_id"
      ]
    }
  },
  "required": [
    "contact_id",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "metadata": {
    "tracking_id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
    "my_id": "123"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "tracking_id": {
          "type": "string",
          "description": "unique uuid."
        },
        "my_id": {
          "type": "string"
        }
      },
      "required": [
        "tracking_id"
      ]
    }
  }
}

Message

Send messages to subscribers

Message

POST /message Send an individual message

Send 1 message to 1 phone number.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/message

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "from": "+15709999898",
  "phone_number": "+15705555555",
  "message": "Example message",
  "metadata": {
    "my_id": "123"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number to send the message to."
    },
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "metadata": {
      "type": "object",
      "properties": {
        "my_id": {
          "type": "string",
          "description": "unique uuid."
        }
      },
      "required": [
        "my_id"
      ]
    }
  },
  "required": [
    "phone_number",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "to": "15705555555",
  "from": "15709999898",
  "message": "Example message",
  "created_at": "2015-07-01T17:23:21+0000",
  "metadata": {
    "tracking_id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
    "my_id": "123"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "Phone number the message was sent to."
    },
    "from": {
      "type": "string",
      "description": "Phone number the message will be sent from."
    },
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "created_at": {
      "type": "string",
      "description": "Date and time the message was sent."
    },
    "metadata": {
      "type": "object",
      "properties": {
        "tracking_id": {
          "type": "string",
          "description": "unique uuid."
        },
        "my_id": {
          "type": "string"
        }
      },
      "required": [
        "tracking_id"
      ]
    }
  }
}

Message Batch

POST /message/batch Send a batch of messages

Send a message to multiple phone numbers.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/message/batch

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "from": {
    "+15705555555": "+15709999898"
  },
  "phone_numbers": [
    "+15705555555"
  ],
  "message": "Example message with ${p1}",
  "send_date": {
    "+15705555555": "2016-07-01T15:11:09.553Z"
  },
  "parameters": {
    "p1": {
      "+15705555555": "parameter 1 value"
    }
  },
  "metadata": {
    "+15705555555": {
      "my_id": "12345"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "from": {
      "type": "object",
      "properties": {
        "+15705555555": {
          "type": "string"
        }
      }
    },
    "phone_numbers": {
      "type": "array",
      "description": "Phone numbers to send the message to."
    },
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "send_date": {
      "type": "object",
      "properties": {
        "+15705555555": {
          "type": "string"
        }
      }
    },
    "parameters": {
      "type": "object",
      "properties": {
        "p1": {
          "type": "object",
          "properties": {
            "+15705555555": {
              "type": "string"
            }
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "+15705555555": {
          "type": "object",
          "properties": {
            "my_id": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "required": [
    "phone_numbers",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "phone_numbers": [
    "+15705555555"
  ],
  "message": "Example message with ${p1}",
  "send_date": {
    "+15705555555": "2016-07-01T15:11:09.553Z"
  },
  "parameters": {
    "p1": {
      "+15705555555": "parameter 1 value"
    }
  },
  "metadata": {
    "+15705555555": {
      "tracking_id": "4e4b3bda-e68b-4981-a5c6-2ddffd52d059",
      "my_id": "12345"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "phone_numbers": {
      "type": "array",
      "description": "Phone numbers to send the message to."
    },
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "send_date": {
      "type": "object",
      "properties": {
        "+15705555555": {
          "type": "string"
        }
      }
    },
    "parameters": {
      "type": "object",
      "properties": {
        "p1": {
          "type": "object",
          "properties": {
            "+15705555555": {
              "type": "string"
            }
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "+15705555555": {
          "type": "object",
          "properties": {
            "tracking_id": {
              "type": "string"
            },
            "my_id": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "required": [
    "phone_numbers",
    "message"
  ]
}

Scheduled Messages

Schedule messages to be delivered to subscribers at a later time.

Scheduled Messages

Schedule messages to be delivered at a later time.

GET /message/schedule List all scheduled messages

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/message/schedule

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
      "created_at": "2016-07-01T15:11:09.553Z",
      "updated_at": "2016-07-01T15:11:09.553Z",
      "message": "This is an example message",
      "send_date": "2016-07-01T15:11:09.553Z",
      "contact": {
        "first_name": "John",
        "last_name": "Doe",
        "gender": "Male",
        "birth_date": "2005-10-29",
        "phone_number": "9999999999",
        "email": "john.doe@mail.com",
        "reward_points": 0,
        "status": {},
        "name": "Pending",
        "description": "A message that has been queued and is ready to be sent"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number",
              "description": "Total number of objects"
            },
            "count": {
              "type": "number",
              "description": "Number of objects returned"
            },
            "per_page": {
              "type": "number",
              "description": "Number of objects displayed per page"
            },
            "current_page": {
              "type": "number",
              "description": "The current page in the result set"
            },
            "total_pages": {
              "type": "number",
              "description": "The number of total pages that can be returned"
            },
            "links": {
              "type": "object",
              "properties": {
                "next": {
                  "type": "string",
                  "description": "A link to the next paginated page, if applicable"
                },
                "previous": {
                  "type": "string",
                  "description": "A link to the previous paginated page, if applicable"
                }
              }
            }
          }
        }
      }
    }
  }
}

POST /message/schedule Create a scheduled message

Create a scheduled message by sending the phone number, message and the date the message should be sent.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/message/schedule

Headers

Content-Type: application/json

Body

{
  "phone_number": "+15705555555",
  "message": "This is an example message",
  "send_date": "2016-07-01T15:11:09.553Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "phone_number": {
      "type": "string",
      "description": "Phone number the message is sent to."
    },
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "send_date": {
      "type": "string",
      "description": "Date the message should be sent. If no date is supplied it is sent immediately."
    }
  },
  "required": [
    "phone_number",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "message": "This is an example message",
    "send_date": "2016-07-01T15:11:09.553Z",
    "contact": {
      "first_name": "John",
      "last_name": "Doe",
      "gender": "Male",
      "birth_date": "2005-10-29",
      "phone_number": "9999999999",
      "email": "john.doe@mail.com",
      "reward_points": 0,
      "status": {},
      "name": "Pending",
      "description": "A message that has been queued and is ready to be sent"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "message": {
          "type": "string",
          "description": "The message to be sent to the specified recipient."
        },
        "send_date": {
          "type": "string",
          "description": "Send date for the message."
        },
        "contact": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "First name of the contact."
            },
            "last_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Last name of the contact."
            },
            "gender": {
              "type": [
                "string",
                "null"
              ],
              "description": "Gender of the contact."
            },
            "birth_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "Birth date of the contact."
            },
            "phone_number": {
              "type": "string",
              "description": "Phone number of the contact."
            },
            "email": {
              "type": "string",
              "description": "Email address of the contact."
            },
            "reward_points": {
              "type": "number",
              "description": "Total reward points the contact has earned."
            },
            "status": {
              "type": "object",
              "properties": {}
            },
            "name": {
              "type": "string",
              "description": "Status of the message."
            },
            "description": {
              "type": "string",
              "description": "Description of the status."
            }
          },
          "required": [
            "phone_number"
          ]
        }
      },
      "required": [
        "id",
        "message"
      ]
    }
  }
}

Schedule Message

GET /message/schedule/{id} Retrieve a scheduled message

Retrieves the details of a scheduled message that was previously created.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

GET https://api.mobiniti.com/v1/message/schedule/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "message": "This is an example message",
    "send_date": "2016-07-01T15:11:09.553Z",
    "contact": {
      "first_name": "John",
      "last_name": "Doe",
      "gender": "Male",
      "birth_date": "2005-10-29",
      "phone_number": "9999999999",
      "email": "john.doe@mail.com",
      "reward_points": 0,
      "status": {},
      "name": "Pending",
      "description": "A message that has been queued and is ready to be sent"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "message": {
          "type": "string",
          "description": "The message to be sent to the specified recipient."
        },
        "send_date": {
          "type": "string",
          "description": "Send date for the message."
        },
        "contact": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "First name of the contact."
            },
            "last_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Last name of the contact."
            },
            "gender": {
              "type": [
                "string",
                "null"
              ],
              "description": "Gender of the contact."
            },
            "birth_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "Birth date of the contact."
            },
            "phone_number": {
              "type": "string",
              "description": "Phone number of the contact."
            },
            "email": {
              "type": "string",
              "description": "Email address of the contact."
            },
            "reward_points": {
              "type": "number",
              "description": "Total reward points the contact has earned."
            },
            "status": {
              "type": "object",
              "properties": {}
            },
            "name": {
              "type": "string",
              "description": "Status of the message."
            },
            "description": {
              "type": "string",
              "description": "Description of the status."
            }
          },
          "required": [
            "phone_number"
          ]
        }
      },
      "required": [
        "id",
        "message"
      ]
    }
  }
}

PUT /message/schedule/{id} Update a scheduled message

Updates the specified scheduled message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

PUT https://api.mobiniti.com/v1/message/schedule/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Content-Type: application/json
Authorization: Bearer <token>

Body

{
  "message": "This is an example message",
  "send_date": "2016-07-01T15:11:09.553Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Message sent to the phone number."
    },
    "send_date": {
      "type": "string",
      "description": "Date the message should be sent. If no date is supplied it is sent immediately."
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "created_at": "2016-07-01T15:11:09.553Z",
    "updated_at": "2016-07-01T15:11:09.553Z",
    "message": "This is an example message",
    "send_date": "2016-07-01T15:11:09.553Z",
    "contact": {
      "first_name": "John",
      "last_name": "Doe",
      "gender": "Male",
      "birth_date": "2005-10-29",
      "phone_number": "9999999999",
      "email": "john.doe@mail.com",
      "reward_points": 0,
      "status": {},
      "name": "Pending",
      "description": "A message that has been queued and is ready to be sent"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "created_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was created."
        },
        "updated_at": {
          "type": "string",
          "description": "ISO Date/time string. When this resource was last updated."
        },
        "message": {
          "type": "string",
          "description": "The message to be sent to the specified recipient."
        },
        "send_date": {
          "type": "string",
          "description": "Send date for the message."
        },
        "contact": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "First name of the contact."
            },
            "last_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Last name of the contact."
            },
            "gender": {
              "type": [
                "string",
                "null"
              ],
              "description": "Gender of the contact."
            },
            "birth_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "Birth date of the contact."
            },
            "phone_number": {
              "type": "string",
              "description": "Phone number of the contact."
            },
            "email": {
              "type": "string",
              "description": "Email address of the contact."
            },
            "reward_points": {
              "type": "number",
              "description": "Total reward points the contact has earned."
            },
            "status": {
              "type": "object",
              "properties": {}
            },
            "name": {
              "type": "string",
              "description": "Status of the message."
            },
            "description": {
              "type": "string",
              "description": "Description of the status."
            }
          },
          "required": [
            "phone_number"
          ]
        }
      },
      "required": [
        "id",
        "message"
      ]
    }
  }
}

DELETE /message/schedule/{id} Delete a scheduled message

Delete a scheduled message.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

DELETE https://api.mobiniti.com/v1/message/schedule/f82e541a-a4b1-11e8-a85f-127fd0971098

URI Parameters

id

string  (required)  Example: f82e541a-a4b1-11e8-a85f-127fd0971098

unique uuid.

Headers

Authorization: Bearer <token>
Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
    "deleted": true
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "f82e541a-a4b1-11e8-a85f-127fd0971098"
          ],
          "description": "unique uuid."
        },
        "deleted": {
          "type": "boolean",
          "description": "Confirmation the scheduled message was deleted."
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Phone numbers

Phone number of the contact.

Phone numbers

POST /phone-numbers/lookup Lookup carrier

Do phone number lookup's and return the carrier's information. Maximum 10 phone numbers per request.

Endpoint information

Access
Requires authentication Yes
Has restricted scope Yes

Example URI

POST https://api.mobiniti.com/v1/phone-numbers/lookup

Headers

Content-Type: application/json

Body

{
  "phone_numbers": [
    "+15709999999"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "phone_numbers": {
      "type": "array",
      "description": "Phone numbers to perform lookups on."
    }
  },
  "required": [
    "phone_numbers"
  ]
}

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "phone_number": "+15709999999",
      "carrier": "Other Carrier",
      "type": "Mobile"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Webhooks

There are a variety of webhooks we offer in our application.

Webhook Requests

Each webhook is sent with a HTTP POST request with the body of the request containing a JSON object.

Inbound Messages

Sends data about an inbound message from a particular contact.

Field Nullable Description
id false Contact ID
first_name true Contact first name
last_name true Contact last name
email true Contact email address
short_code true Number that the contact texted into
phone_number true Contact phone number
message true Message the contact sent
unsubscribed_at true Contact unsubscribe date and time
created_at false Contact creation date and time
updated_at false Contact last updated date and time
received_at false Date and time the message was received 
{
  "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
  "first_name": null,
  "last_name": null,
  "email": null,
  "short_code": "64600",
  "phone_number": "+19999999999",
  "message": "This is an example message",
  "unsubscribed_at": null,
  "created_at": "2016-07-01T15:11:09.553Z",
  "updated_at": "2016-07-01T15:11:09.553Z",
  "received_at": "2016-07-01T15:11:09.553Z"
}

Unsubscribe Messages

Sends data about a contact that was unsubscribed.

Field Nullable Description
id false Contact ID
first_name true Contact first name
last_name true Contact last name
email true Contact email address
phone_number true Contact phone number
to false Number that the contact texted into
unsubscribed_at true Contact unsubscribe date and time
created_at false Contact creation date and time
updated_at false Contact last updated date and time 
{
  "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
  "first_name": null,
  "last_name": null,
  "email": null,
  "phone_number": "+19999999999",
  "to": "64600",
  "unsubscribed_at": "2016-07-01T15:11:09.553Z",
  "created_at": "2016-07-01T15:11:09.553Z",
  "updated_at": "2016-07-01T15:11:09.553Z",
}

Delivery Reports

Sends delivery report data for each message that is sent to a contact.

List of possible status codes and messages.

Code Message Retriable
100 The message delivered successfully No
101 Message Blocked. No
102 Internal Routing Error. No
103 Location not found. Internal routing error. No
104 Location blocked. Internal routing error. No
105 Rejection due to failed authentication or filtering. No
106 Destination number is not a valid mobile number or its routing cannot be determined. No
107 Rejection due to subscription not supporting SMS. No
108 Routing Error. Dialing zone not found. No
109 Rejection due to subscription or network not allowing SMS. No
110 Unreachable destination handset. The destination handset is switched off or otherwise unavailable. Yes
111 Subscriber handset is not reachable on the network due to it being turned off or out of coverage. Likely to have very recently become unavailable. Yes
112 Subscriber handset is not reachable on the network due to it being turned off or out of coverage. Likely to have been unavailable for several hours. Yes
113 Terminating reservation failed. Yes
114 Terminating reservation denied subscription not found. No
115 Terminating reservation denied subscription state illegal. No
116 The end user is out of prepaid credit and cannot receive the message at the moment. Yes
117 Terminating reservation denied call case blocked for subscription type. No
118
Screening Error. Terminating reservation denied due to low balance. Internal error.		 No
119 System Congestion. Internal error. Yes
120 Generic delivery failure Yes
121 Message text is too long. No
122 Reject. Indicates temporary problem or lost reach. Yes
123 Unidentified subscriber. Yes
124 Subscriber is absent and has been for a period of time. Yes
125 This message was identified as spam and cannot be delivered. No
126 Subscriber busy. The message is rejected because of congestion encountered at the Carrier. Yes
127 Message submitted to but not acknowledged by the mobile operator. Yes
128 Illegal equipment. Message rejected because the mobile subscriber was blacklisted. No
129 System failure. Message rejected due to network or protocol failure. Yes
130 Invalid destination address. The MSISDN does not exist. Please Confirm Number Validity. No
131 Invalid destination numbering plan. No
132 Invalid destination type of number. Yes
133 Invalid destination flag. No
134 Invalid number of destinations. Yes
135 SMSC partner cannot route this message and it will not be retried. No
136 Message is queued within REST API system and will be dispatched according to the rate of the account. No
137 Message has been dispatched to SMSC. No
138 SMSC rejected message. Retrying is likely to cause the same error. No
139 An unexpected error caused the message to fail. No
140 Message failed because of temporary delivery failure. Message can be retried. Yes
141 One or more parameters in the message body has no mapping for this recipient. No
142 Message expired before it reached handset. Yes
143 Message was canceled by user before reaching SMSC. Yes
144 SS7 signalling link at destination network, SMSC, or 3rd party signalling partner is overloaded. Yes
214 MSC Error. Absent subscriber, no page response. The message is rejected because there was no paging response. Yes
215 Account Suspended. Please Contact Support. No
216 Content blocked by user opt-out. Messaging can resume to the end user only if the end user opts back into your program. No
217 Number not Provisioned by the Carriers. Please Contact Support. No
218 Illegal subscriber. Message rejected because of failed authentication. No
219 Message Queue Overflow. Yes
220 The requested service is not supported by the handset or network. No
221 Indicates that the service is not compatible. No
222 Message has been successfully accepted and processed by our platform and forwarded to the mobile operator. No
223 Message has been successfully delivered to the mobile operator and awaits further processing or delivery to the recipient's handset. No 
{
  "total_messages": 1,
  "statuses": [
    {
      "code": "100",
      "status": "The message delivered successfully.",
      "count": 1,
      "recipients": ["19999999999"],
      "success": true,
      "bounce": false
    }
  ],
  "messages": [
    {
      "id": "a8a2b40a-86ae-4a91-a61d-7b7ccfc4b148",
      "from": "+15555555555",
      "message": "This is an example message",
      "phone_number": "9999999999",
      "metadata": []
    }
  ]
}

Contact Status

Sends contact information when the status of a contact changes based on data received from carriers. The status field can have one of the following: suspended, deactivated, resumed, transferred

Field Nullable Description
id false Contact ID
first_name true Contact first name
last_name true Contact last name
email true Contact email address
phone_number false Contact phone number
previous_phone_number Only present in the transferred event
status false suspended, deactivated, resumed, or transferred
created_at false Contact creation date and time
updated_at false Contact last updated date and time 
{
  "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
  "first_name": null,
  "last_name": null,
  "email": null,
  "phone_number": "+19999999999",
  "status": "deactivated",
  "created_at": "2016-07-01T15:11:09.553Z",
  "updated_at": "2016-07-01T15:11:09.553Z",
}

Bounced Message

Sends contact information when an outgoing message is detected as being a bounce based on data received from the carriers.

Field Nullable Description
id false Contact ID
first_name true Contact first name
last_name true Contact last name
email true Contact email address
phone_number false Contact phone number
unsubscribed_at true Contact unsubscribe date and time
bounces false Number of bounced messages
created_at false Contact creation date and time
updated_at false Contact last updated date and time 
{
  "id": "f82e541a-a4b1-11e8-a85f-127fd0971098",
  "first_name": null,
  "last_name": null,
  "email": null,
  "phone_number": "+19999999999",
  "unsubscribed_at": "2016-07-01T15:11:09.553Z",
  "bounces": 2,
  "created_at": "2016-07-01T15:11:09.553Z",
  "updated_at": "2016-07-01T15:11:09.553Z",
}

Rejection Message

The ability to see if there was an error, validation, provider error or DLR if a message comes back as "failed".

Field Nullable Description
code false Status Code
message false Test message
description false Description 
{
    "code": "",
    "message": "",
    "description": "Unsubscribed"
}

To set up, navigate to Settings -> Notifications. Scroll down to "Rejected Message" paste your webhook into the URL box, and hit submit.