Paubox Email API: REST API Setup

A Paubox subscription or trial subscription is required (don't have one? sign up here!)

Before sending email via the REST API, you must first configure your account: adding a sending domain to your Paubox account, verifying domain ownership, updating the domain's SPF record, and generating an API key.

Note that the Paubox Email API is built for developers to programmatically send email; please direct any code questions or issues to your organization's development team. 

Setup

Add a sending domain to your Paubox account (if it's not already added)
1) Log in to the Paubox dashboard: https://app.paubox.com/users/sign_in
2) Navigate to Paubox Email API > Settings in the left navigation menu
3) Click Add New Domain (at the top left) to add a sending domain,

4) Enter the domain name, and click the Add button

Verify domain ownership - Verification record
1) From the Paubox Email API section of the dashboard, click on Settings
2) Next to the sending domain, click on Domain Settings (on the right)
3) Enter a TXT or CNAME record to your domain as instructed to verify ownership *
4) The status will change when the record has propagated (Check now to see if it's ready)

Verify domain ownership - Update your domain's TXT/SPF record
1) Locate your domain's SPF record (of type TXT, starts with v=spf1) **
2) Edit the record to include this value: include:_spf.paubox.com
3) This guide shows some examples of editing SPF records
4) The status in the dashboard will change when the record has propagated (Check now to see if it's ready)

Generate an API Key (after domain shows as "Verified")
1) From the Paubox Email API section of the dashboard, click on Settings
2) Next to the sending domain, click on Domain Settings (on the right)
3) At the bottom of the screen click New API Key and record the key (you will not be able to retrieve the key later)

You will need the Endpoint Username and API Key for the sending domain from your Paubox dashboard.

* When verifying your domain with a new TXT record, enter this value in the host field: pb.verify
** If your domain does not have an SPF record, create a new one of type TXT with this value: v=spf1 include:_spf.paubox.com -all

You can find SDKs to work with on our GitHub page
https://github.com/Paubox/

Here is a link to the REST API documentation for your reference
https://docs.paubox.com/docs/paubox_email_api/introduction

You can use Postman to import this collection of examples for testing
https://www.getpostman.com/collections/daa6563a07958530c061