Skip to main content

Postman

This article teaches you how to test SMS and email messages using Postman with the SMSByrd API.

Before you begin​

If you don’t already have one, create a SMSByrd account.

Make sure you know how to send email to SMSByrd first. Once you have this working, you’re ready to start testing!

1. Create an API key​

Account-level API keys allow you to access all the functions described in the API reference, and have access to all the servers in your account.

To create an account-level API key, you must be an Administrator or Account Owner on the account in question.

  1. Go to the Settings page in the SMSByrd Dashboard.
  2. Go to the API Keys page.
  3. Click the Create a Key button.
  4. In the dialog that appears, enter a name for your key.
  5. When you are finished, click Create.

For more information, see our guide on managing API keys.

2. Fork the SMSByrd Postman Collection​

SMSByrd has a public Postman Collection which you can access by clicking the button below:

//add button

Once you have the collection loaded, simply enter your API key from step 1 above into the Authorization tab, by ensuring the Basic Auth type is selected, with your API key entered as the Username. Once this is done you’re ready to start calling the endpoints in the collection!

//photo