How to migrate your Bandwidth inbox to OAuth credentials
Bandwidth is retiring legacy API User authentication on December 2, 2026. If your Bandwidth inbox still uses an API Key and API Secret, migrate it to OAuth credentials by December 1, 2026 to keep messaging connected.
You can update credentials on your existing inbox. Your phone number, conversations, and message history stay in place. You do not need to delete or recreate the inbox.
Before you begin
Section titled “Before you begin”-
You need administrator access to your StrataBlue Support account.
-
You need access to API Credentials in your Bandwidth account. If this option is missing, ask your Bandwidth administrator to enable the Credential access role.
-
For self-hosted installations, Bandwidth OAuth migration is available in StrataBlue Support 4.20 and later. Upgrade to version 4.20 or later before following these steps.
1. Create OAuth credentials in Bandwidth
Section titled “1. Create OAuth credentials in Bandwidth”-
Sign in to the Bandwidth App and open Account → API Credentials.
-
Select Add Credential. Choose the account and roles needed for your existing messaging integration, and set a secret expiration date appropriate for your team.
-
Save the credential, then copy the Client ID and Client Secret. Store the secret securely: Bandwidth only displays it once.
For provider instructions, see Bandwidth’s API User Migration guide.
2. Update your existing inbox in StrataBlue Support
Section titled “2. Update your existing inbox in StrataBlue Support”-
Open Settings → Inboxes and select your Bandwidth inbox.
-
Open the Configuration tab. You can also select Update credentials in the migration notice.
-
Check the saved Account ID and Application ID. These fields are read-only.
-
Enter the new Client ID and Client Secret.
-
Select Verify and save credentials.
StrataBlue Support verifies the credentials before saving them. After a successful update, the migration notice disappears and the Client Secret field clears. Your callback URL stays the same.
The Configuration tab for an existing Bandwidth inbox:
3. Test messaging after migration
Section titled “3. Test messaging after migration”Credential verification confirms authentication. Before considering the migration complete:
-
Send an SMS from the existing StrataBlue Support inbox and confirm it reaches the recipient.
-
Reply from the recipient’s phone and confirm the message appears in the same inbox and conversation.
-
If you use MMS, test sending and receiving a message with an attachment.
Repeat the update and messaging checks for every Bandwidth inbox that uses legacy credentials.
If you cannot save the credentials
Section titled “If you cannot save the credentials”-
Credentials rejected: Check that you entered the Client ID and Client Secret from API Credentials, rather than the legacy API Key and API Secret. Confirm the credential covers the correct account, has the required messaging access, and has an active secret.
-
Temporary provider error: Try again when Bandwidth is available. An unsuccessful verification leaves your previously saved configuration unchanged.
-
Account ID or Application ID is incorrect: Contact StrataBlue Support support before proceeding. Token verification alone does not confirm that these saved identifiers are correct.
-
Configuration tab or OAuth fields are missing: On a self-hosted installation, update to StrataBlue Support 4.20 or later. Contact support if you use StrataBlue Support Cloud.
What happens to legacy credentials?
Section titled “What happens to legacy credentials?”Inboxes that have not been migrated continue using their saved legacy credentials until Bandwidth retires API User authentication. Once you save OAuth credentials, that inbox uses OAuth and does not fall back to legacy authentication.
Do not deactivate legacy API Users until you have verified every application and inbox that depends on them. Updating one StrataBlue Support inbox does not migrate other integrations using the same legacy credentials.
Bandwidth’s deadline and credential requirements are explained in Creating and managing your Bandwidth API credentials.