Phone Numbers

Request a higher phone number allowance

Needs a verified business (BUSINESS_VERIFICATION_REQUIRED until then; see /v1/business-verification). Files a request for HonkIO staff to review. Only one request may be pending at a time. Approval raises the account limit; you are emailed when that happens.

Requires phone_numbers:w.

post/v1/phone-numbers/allowance-requests

Request

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

Request body

requested_limitinteger required

Total numbers you want to be able to hold (not an increment)

reasonstring required

What you need them for. Staff decide on this.

Response

The request, pending review.

idstring required
requested_limitinteger required

Total numbers asked for, not an increment.

limit_at_requestinteger required
held_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.