Update Email-to-SMS Settings Using Aerialink v5 API (Swagger)

Use this guide to add, update, or remove Email-to-SMS settings for a code using the Aerialink v5 API Swagger. This article walks through the PATCH endpoint configuration process and explains how to validate the changes successfully.

Overview

The Aerialink v5 API allows administrators to manage Email-to-SMS settings associated with a code through the Swagger.

Using the PATCH endpoint, you can configure:

• Email to SMS Name
• Email Address
• Email Domain
• Email Template ID

This functionality is commonly used when enabling or updating email forwarding behavior for a messaging code.

Important Note

What You'll Need

Before you begin, make sure you have:

• Access to the Aerialink v5 Swagger UI
• API credentials with code_write permissions
• The code value you want to modify
• The Email-to-SMS values you plan to configure

Step-by-Step Guide

Follow these steps to complete the setup:

1. Log in: Access your Convey account and navigate to the main dashboard.
2. Locate the setting: Click on the Settings icon (gear) in the top right corner.
3. Make the change: In the text field, enter your desired value or select it from the dropdown.
4. Save your progress: Click the green Save Changes button at the bottom of the screen to apply your updates.

Having Trouble?

If you encounter any issues along the way, refer to this quick troubleshooting guide.

What you're seeing	Why it happens	How to resolve it
[Error Message]	A simple explanation of the root cause.	The exact step the user should take to fix the error.
[Feature Not Visible]	Your account may not have the required permissions.	Reach out to your team's administrator to request access.

Tips for Success

To get the most out of this feature, keep the following tips in mind:

Common Pitfalls

• × Navigating away from the page without saving first.
• × Using unsupported file formats such as [Format].
• × Sharing your private API keys or login credentials.

Best Practices

• ✓ Always double-check your data before submitting.
• ✓ Use clear, standard naming conventions for your files.
• ✓ Keep your browser up to date for the best experience.

Frequently Asked Questions

Q: What happens if I accidentally delete my configuration?

A: Don't worry! You can easily restore the previous version by navigating to the History tab and selecting 'Restore'.

Need More Help?

If you've followed the steps above and are still having trouble, our support team is ready to assist you.

• Contact Support Submit a ticket to our team for personalized help.
• Related Article Link to another relevant KBA.
• Video Tutorial Watch a quick walkthrough of this process.