Custom Message Limit

The custom message limit imposes a hard limit on how many messages your account can send during a calendar month.

Get current custom sending limit

get/v5/accounts/limit/custom/monthly

Fetch the details of custom sending limit on the account

SecuritybasicAuth
Responses
200

A 200 response

Response Schema: application/json
limit
number

The custom limit set for the account

current
number

The number of messages already sent

period
string

The timeframe for which the limit applies - m for months, d for days, h for hours

404

A 404 response

Request samples
Response samples
application/json
{
  • "limit": 10000,
  • "current": 0,
  • "period": "1m"
}

Set a custom sending limit

put/v5/accounts/limit/custom/monthly

Set a custom sending limit

SecuritybasicAuth
Request
query Parameters
limit
required
number

The limit to set

Responses
200

Successfully set the sending limit

Response Schema: application/json
success
boolean

Indicates success of request

400

Error response

Request samples
Response samples
application/json
{
  • "success": true
}

Delete a custom sending limit

delete/v5/accounts/limit/custom/monthly

Delete a custom sending limit

SecuritybasicAuth
Responses
200

Successfully deleted the sending limit

Response Schema: application/json
success
boolean

Indicates success of request

400

Error response

Request samples
Response samples
application/json
{
  • "success": true
}

Re-enable account disabled for hitting send limit

put/v5/accounts/limit/custom/enable

Re-enable an account that was disabled for reaching the custom sending limit

SecuritybasicAuth
Responses
200

Successfully re-enabled the account

Response Schema: application/json
success
boolean

Indicates success of request

400

Error response

Request samples
Response samples
application/json
{
  • "success": true
}