border.bot
Docs menu

API reference

Block many codes

POST https://api.border.bot/v1/classify/blocklist/import

Requires an API key (Authorization: Bearer bb_live_…).

Block a list of codes at once, or with replace: true make the list exactly these. All or nothing: an import that would pass 5,000 codes changes nothing. Free.

API key scope: settings.

Request body (JSON)#

Name Type Required Description
codes object[] yes
replace boolean no

Responses#

  • 200: What the import added, updated and removed. (BlockedCodesImportResponse)
  • 400: Invalid input (invalid_input). (Error)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the settings scope (forbidden, details.reason: "missing_scope"). (Error)
  • 429: Rate limited (rate_limited). Retry after Retry-After seconds; RateLimit says which limit was hit (r=0, t seconds until its window ends) and RateLimit-Policy its quota. (Error)
  • 500: Unexpected error (internal). (Error)

Example#

bash
curl -X POST 'https://api.border.bot/v1/classify/blocklist/import' \
  -H 'Authorization: Bearer bb_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"codes":[{"code":"6109.10","destination":"US","reason":"Our broker files these under 6109.90"},{"code":"9503"}],"replace":false}'