BeaconBox
Esc

Type to search.

Dashboard

Get an update

One update with its delivery status: delivered, opened, bounced, and whether an email was ever attempted.

GET/api/v1/messages/{public_id}

Request

curl https://api.beaconbox.eu/api/v1/messages/v55favd767qu \
  -H "Authorization: Bearer $BEACONBOX_API_KEY"

Path parameters

NameTypeDescription
public_idstring

Response

Returns 200.

FieldTypeDescription
idstring
recipient_emailstring
subjectstring
kind"one_off" | "updateable"
status"active" | "obsolete" | "retracted"
created_atdate-time
updated_atdate-time
deliveryobject

Errors

Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.