Skip to main content
Create a key your application uses to send email through the send API. A sending key goes in the Authorization: Bearer header of calls to POST https://mailing-service.prod.brudcast.com/api/v1/send. It starts with bk_live_.
Before you start: you need a sending domain of your own. Sending keys aren’t available on the managed sending address.

​
Domain key or organization-wide key

Prefer domain keys. If a domain key leaks, it can only send from that one domain, and it can’t read contacts, change domains or touch billing. To use an organization-wide key, add the messages:send scope when you create it. The scope can’t be added to an existing key later. See API keys.

​
Create a domain sending key

1

Open the domain's Sending Keys tab

Go to Channels > Email, open the Domains tab, select the domain, then select the Sending Keys tab.
2

Add a key

Select Add Sending Key. In Description, name the application that will hold it, for example Checkout service. Select Create Key.
3

Copy the secret

The Sending Key Created dialog shows the API Key ID and the API Secret Key. The secret is shown once. Copy it into your application’s secret store, then select Done.
The key shows Provisioning for a few seconds, then Active. It’s ready to send once it’s Active. The Last Used column shows when it last authenticated.

​
Use it

The send API only accepts the key in the Authorization: Bearer header. For a domain key, the from address must be on that key’s domain. Otherwise the call fails with From address domain 'x' does not match sending key domain 'y'. More examples are in Send your first email and Send email over HTTP.

​
Regenerate a key

On the key’s row, open the More actions menu (the three-dot icon) and select Regenerate Secret Key, then Regenerate. The new secret is shown once, and the old one stops working straight away, so every service using it needs the new value. For a change with no gap, create a second key, deploy it everywhere, then delete the first.

​
Delete a key

On the key’s row, open the More actions menu (the three-dot icon), select Delete, then Delete Key. Anything using it fails on its next request. Delete a key as soon as you suspect it has leaked, then create a new one.

Send email over HTTP

The full request and response reference.

API keys

Platform API keys, scopes and organization-wide sending.

SMTP users

Credentials for the SMTP relay.