📦
Mobivate Bulk API Documentation
  • 👋Welcome to BulkSMS
  • AUTHENTICATION & INTEGRATION
    • Getting started with Integration
      • Creating a New API Key
      • Get API Key
      • Test API Key
    • Registering Webhooks
      • Delivery Receipt Notification
      • Incoming Message Notification
      • Short URL Click Notification
    • Understanding Response Codes
  • USE CASES
    • Send Single SMS Message
      • Understanding SMS Response Codes
    • Send Batch SMS Messages
      • Understanding Batch SMS Response Codes
    • Search Message logs
    • Search for Single Message log
    • List OptOuts
    • Add an OptOut
    • Delete an OptOut
    • Frequently Asked Questions
  • 📚Integrations
    • Integrating Mobivate framework into your own application
    • Automate SMS messages using events through Zapier
    • Asynchronous Number Verification
    • Synchronous Number Verification
    • Adding / Removing Contacts
    • Creating New Contact Group
  • 🔓ARCHIVED DOCS
    • Sending simple Notification messages
    • Sending SMS from 3rd Party Providers
    • Sending Campaigns
Powered by GitBook
On this page

Was this helpful?

  1. AUTHENTICATION & INTEGRATION
  2. Getting started with Integration

Get API Key

This document will detail how to obtain an existing API key.

POST /auth/getkey

Get your currently available api-key from your Mobivate account.

curl -X POST \
"https://api.mobivatebulksms.com/auth/getkey" \
-H 'Content-Type: application/json' \
-d '{ "username": "[USERNAME]", "password": "[PASSWORD]"}'
import requests

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

json_data = {
    'username': '[USERNAME]',
    'password': '[PASSWORD]',
}

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

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "username": "[USERNAME]", "password": "[PASSWORD]"}'
#response = requests.post('https://api.mobivatebulksms.com/auth/getkey', 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"
}
{
   "code":401,
   "message":"Invalid Credentials"
}

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.

PreviousCreating a New API KeyNextTest API Key

Last updated 1 year ago

Was this helpful?

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

click here