Creating a New API Key

This document will go over how to generate/create a new API key.

`POST` `/auth/createkey`

Create/generate a new API key for your Mobivate account.

curl -X POST \
"https://api.mobivatebulksms.com/auth/createkey" \
-H 'Content-Type: application/json' \
-d '{ "username": "[email protected]", "password": "your-pass"}'

import requests

headers = {
    'Content-Type': 'application/json',
}

json_data = {
    'username': '[email protected]',
    'password': 'your-pass',
}

response = requests.post('https://api.mobivatebulksms.com/auth/createkey', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "username": "[email protected]", "password": "your-pass"}'
#response = requests.post('https://api.mobivatebulksms.com/auth/createkey', headers=headers, data=data)

Headers

Name

Value

Content-Type

application/json

Authorization

No Auth

Body

Name

Type

Required?

Description

username

string

Yes

Your username used to login.

password

string

Yes

Your password used to login.

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).

{
   "apiKey":"abcd1234-9922-abcd-1234-abcd1234abcd"
}

Upon a successful send request, our server will respond with a 200 (success) HTTP response code, and you will be provided with an API Key. The API Key will be used in subsequent calls to the API.

Please note: A successful call to this endpoint will revoke your existing API Key!

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

PreviousGetting started with Integration NextGet API Key

Last updated 1 year ago

hashtagPOST /auth/createkey

`POST` `/auth/createkey`