Connecting Apps and Managing API Keys
Give each application its own sending key, limit its access, and replace or turn off keys.
Open Connected apps. An initial key appears when the account has an eligible product. For a separate application:
- Click Connect another app.
- Enter a recognisable name under Which app is this, such as Booking system.
- Select Send email from your address.
- Choose which sending domains it may use.
- Leave newsletter subscriber access at No access if the app does not need it.
- Click Connect.
Share the Send API & setup page with the person connecting your software. It shows the endpoint and sending domain. The public API documentation provides code examples and testing instructions without requiring a dashboard login.
Keep keys in server-side settings, never in a public repository or browser code. Use Replace to rotate a key; the page lets you choose an overlap while the app is updated. Turn off immediately stops a connected key and prevents its pending scheduled emails from being sent. Other app keys continue working.
Connecting more apps does not create a separate allowance for each one.
Replace a key without interrupting an app
- Find the app in Connected apps and click Replace.
- Choose how long the old key should keep working while your developer updates the app, up to a week.
- Confirm Replace, put the new key in the app's server-side settings, and check a test send.
- Check the retirement time shown beside the old key.
Replacement keeps the key's name and limits. Emails already scheduled by the old key remain scheduled. If the key has been exposed, choose to stop it straight away. A retiring key also has Stop it now.
Turn off is different from replacement: it immediately stops a connected key and stops its pending scheduled sends. Use it when retiring an app.
Find an API error
Open API request log. Paste the request ID or search the endpoint address, choose Only errors, and open a row. The details explain why the call was refused and which fields need fixing. The log covers the last 30 days.