BeaconBox
Esc

Type to search.

Dashboard

API reference

Every operation an API key can call. Twenty of them, across five resources, generated from the published specification.

The base URL is https://api.beaconbox.eu and every path is prefixed /api/v1. Authentication is a bearer API key on every call; see Authentication.

The session-authenticated admin surface that serves the dashboard is not here, because no API key can call it. If you are looking for a way to buy credits or change account settings from code, there is not one: those are dashboard actions.

Messages

OperationMethodPath
Push an updatePOST/messages
List updatesGET/messages
Get an updateGET/messages/{public_id}
Push a batchPOST/messages/batch
Retract an updatePOST/messages/{public_id}/retract
Resend the SMSPOST/messages/{public_id}/sms
Resend the WhatsApp messagePOST/messages/{public_id}/whatsapp

Recipients

OperationMethodPath
Get a recipientGET/recipients/{email}/sms
Set a phone numberPUT/recipients/{email}/phone
Clear a phone numberDELETE/recipients/{email}/phone
Erase WhatsApp historyPOST/recipients/{email}/whatsapp/erase
Erase a recipientPOST/recipients/{email}/erase

Credits

OperationMethodPath
Get the balanceGET/credits

API keys

OperationMethodPath
List API keysGET/keys
Create an API keyPOST/keys
Revoke an API keyDELETE/keys/{key_id}

Webhook endpoints

OperationMethodPath
List webhook endpointsGET/webhook-endpoints
Create a webhook endpointPOST/webhook-endpoints
Test a webhook endpointPOST/webhook-endpoints/{public_id}/test
Delete a webhook endpointDELETE/webhook-endpoints/{public_id}

The specification

Download the OpenAPI document (2026-10-02, 20 operations). It is filtered to the key-callable surface, so a client generated from it has exactly the operations above and nothing that would answer 401.

That date labels the document, not the API. BeaconBox reads no version header and pins nothing per account, so there is no version for a caller to select: it is a snapshot label, and the current document is always the one linked here.