Accounts

Request a higher daily sending volume

Needs a verified business (BUSINESS_VERIFICATION_REQUIRED until then; see /v1/business-verification), and opens once the account has completed its probation period (counted from its first live send). Omit requested_limit to ask for the standard approved volume, or name a target. One request may be pending at a time; you are emailed when it is decided.

Requires account:w.

post/v1/send-limit/requests

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/send-limit/requests
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

requested_limitinteger

Messages per day you want (not an increment). Omit for the standard approved volume.

reasonstring required

What you send and to whom. Staff decide on this. 10 to 1000 characters.

Response

The request, pending review.

idstring required
requested_limitinteger nullable required

Messages per day asked for; null asks for the standard approved volume.

limit_at_requestinteger required
sent_last_30d_at_requestinteger required
reasonstring required
status'PENDING' | 'APPROVED' | 'DENIED' required
granted_limitinteger nullable required
staff_notestring nullable required
decided_atstring date-time nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.