You can create and manage as many API Keys as you need! Each API Key can have a unique name, specific to it’s use case and environment.

To get started, visit the API Settings page and click Create New API Key. Name your API key and select one of the following keys:

  • Production Key
  • Test Key
  • Override Key
  • Test Send Key

Once selected, click Create API key and a screen with your new API key will appear.

Important For security reasons, your newly created API key will not be shown again — please store this API key somewhere safe as Sendwithus will not be able to retrieve this key.

Types of API Keys

Production Keys

Production keys will always send real email to real customers. Emails sent using production keys will show up in email logs and analytics. These keys should only be used when accessing the API in production applications.

Test Keys

For use in testing and development environments. Behaves like a Production API Key but emails are never delivered and will not display in logs or analytics. They’re great for environments that need to make Sendwithus API calls, but where email is not the focus. Test keys will add [Sendwithus Test] to the subject lines of your emails.

Note that all types of Test API keys will not create or update customers in Sendwithus.

Override API Keys

These new API Keys let you direct all email sends to a single email address. We use them internally for development, and we love them so much we wanted to offer them to everyone. They’re great for testing and QA environments, especially when you want to send test emails but don’t want to accidentally spam your customers.

Test Send Keys

These keys behave like Production API Keys, except the analytics won’t be tracked. Logs will still be found under the test logs page.