Test API Key

This document will detail how to test your existing API key.

GET /auth/test

Test your existing Mobivate API key to ensure it's ready for API use.

Curl

curl -X GET \
"https://api.mobivatebulksms.com/auth/test" \
-H 'Authorization: Bearer [API Key]'

Python

import requests

headers = {
    'Authorization': 'Bearer [API Key]',
}

response = requests.get('https://api.mobivatebulksms.com/auth/test', headers=headers)

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <api key>

Body

There are no Arguments required to test your existing API key.

Response

We use conventional HTTP response codes to indicate the success or failure of an API request. In general:

2xx indicate success 4xx indicate an error that failed given the information provided (e.g., a required parameter was omitted) 5xx errors indicate an error with ours servers (these are rare).

200

{
   "message":"API Key is valid"
}

401

{
   "code":401,
   "message":"Unauthorized"
}

To see a full list of our Response codes, please click here.