Creating a new API key
API keys are used to authorise your account to make requests to the Mobivate API. Each API key is associated with specific permissions and optional restrictions to help you control how it is used.
To create a new API key, follow these steps:
Log into your Mobivate account.
Click the cog icon in the top-right corner of the page.
Click on User Profile.
Navigate to the API Keys tab.
Click New API Key.
Permissions
Each API key can be configured with specific permissions that determine which actions it can perform within the Mobivate platform. Permission requirements will vary depending on your use case, so we recommend enabling only what you need.
Allowed IPs (IP Ranges)
You can restrict an API key so it is only usable from specific IP addresses or IP ranges. If you do not wish to apply any IP restrictions, we recommend selecting Anywhere (IPv4).
Daily Message Limit
You may optionally set a daily message limit to cap the number of messages that can be sent using an API key.
A value of 0 means no limit (recommended by default).
Daily limits reset automatically at midnight UTC.
Receipt URL
If you want to receive delivery notifications for SMS messages outside of the Mobivate platform, you can provide a receipt (callback) URL here. If left empty, no external delivery notifications will be sent.
Storing your API key
When a new API key is created, you will have the option to copy it to your clipboard or download it.
For security reasons, your API key is only shown once at creation time. If you lose or forget your key, it cannot be retrieved and a new API key will need to be generated.
Last updated