post
https://api.octopush.com/v1/public/subaccount/create
Encoding : UTF-8
Authentication
Your "api-key" and "api-login" identifiers must be added in the headers.
Definition
This web service allows you to create a new sub-account.
Special parameters
| Name | Type | Description |
|---|---|---|
| first_name | string | First name to be associated with the sub-account. |
| last_name | string | Last name to be associated with the sub-account. |
| password | string | Sub-account password. |
| company_name | string | (optional) Company name. |
| callbacks | array | Table containing callback URLs. { 'callback_url_for_inbounds': 'https://dns.com/url-1', 'callback_url_for_sms_deliveries': 'https://dns.com/url-2', 'callback_url_for_voice_sms_deliveries': 'https://dns.com/url-3', 'callback_url_for_blacklisted_numbers': 'https://dns.com/url-4', 'email_for_inbounds': '[email protected]'} |
Callbacks URLs
| Name | Description |
|---|---|
| callback_url_for_sms_deliveries | URL where you would like to receive AR SMS callbacks. |
| callback_url_for_blacklisted_numbers | URL where you would like to receive unsubscribe requests (stops). |
| callback_url_for_voice_sms_deliveries | URL where you would like to receive callbacks from AR SMS Voice. |
| callback_url_for_inbounds | URL where you would like to receive inbound SMS callbacks. |
| email_for_inbounds | Email address to which you would like incoming SMS messages to be forwarded. |
How Our API Deals With Incorrect Data
The API we provide will try to interpret your request as best it can. If a parameter has the wrong value, we will try to understand it anyway. If the parameter has the wrong type, we will try to format it as best we can. Thus, we have determined default values, which are indicated in our documentation. If a parameter could not be recognized or "fixed", we will ignore it, but your request will be sent.
If one of your parameters does not have the right value, or does not have the right type, we will try to:
- "cast" (convert) it so that it can be understood.
- format it (delete prohibited characters for example)
Server Response Example in JSON
Success
{
"email": "[email protected]",
"api_key": "**********"
}
Bad request.
Unauthorized
Forbidden to view.