border.bot
Docs menu

API reference

API reference

Remove a restricted-goods rule

DELETE https://api.border.bot/v1/restrictions/rules

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

Removes one of your rules by its id. Free.

API key scope: settings.

Parameters#

Name Type Required Description
id string (uuid) yes The rule’s id.

Responses#

  • 200: Whether a rule was removed. (RestrictionRuleRemoveResponse)
  • 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 DELETE 'https://api.border.bot/v1/restrictions/rules' \
  -H 'Authorization: Bearer bb_live_...'