Skip to main content
PUT
Update scheduled SMS messages status

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Query Parameters

bulkId
string
required

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.

Example:

"BULK-ID-123-xyz"

Body

status
enum<string>
required

The status of the message(s).

Available options:
PENDING,
PAUSED,
PROCESSING,
CANCELED,
FINISHED,
FAILED

Response

successful response

bulkId
string

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.

status
enum<string>

The status of the message(s).

Available options:
PENDING,
PAUSED,
PROCESSING,
CANCELED,
FINISHED,
FAILED