API Portal
Email domain and templates
Send API Portal email from your own authenticated domain or a verified single sender, edit the notification templates Apiable sends automatically, add your own templates for plan version notices, and set where contact form messages go. Available on plans that include custom email.
Two settings control your API Portal's email. Email Sender Identity sets the address portal email is sent from, by authenticating a whole domain or verifying a single sender. Templates holds the notification templates and the contact form's recipient. Both are available on plans that include custom email.
How do you set up a sending identity for your API Portal?
Open Settings, Portal settings, Email Sender Identity and pick an Authentication method. Domain authenticates a whole sending domain. Single Sender verifies one address. The method locks once you have created either.
| Method | What it does |
|---|---|
| Domain | Proves you own a domain with DNS records. Your portal then sends from an address on it. |
| Single Sender | Verifies one address through a link sent to that address. |
Once verified, the page confirms that all emails from your portal will be sent from your address.
How do you authenticate a sending domain?
Choose Domain, fill in Domain Authentication, and choose Create. Add the DNS records the page lists, tick I have added the DNS records., and choose Verify. Records move from Pending to Valid as they are found.
- Under Authentication method, choose Domain.
- Enter the Domain, the Email address to send from, and a Sender Name. The address must be on the domain.
- Choose Create. A table of DNS records appears with STATUS, TYPE, HOST and VALUE.
- Add each record at your DNS provider. Use the copy buttons for HOST and VALUE.
- Tick I have added the DNS records., then choose Verify.
- When the page says "Domain verified successfully.", use Send a test email to check delivery.
If it says "Failed to verify domain, please check the DNS records.", give your DNS changes time to spread, then choose Verify again. Once the domain is created, Create becomes Update, which changes the sending address. The domain and sender name stay fixed.
How do you verify a single sender instead?
Choose Single Sender, fill in the sender details, and choose Create New Sender. A verification email goes to the From email address. Copy the link from it into Verification Link and choose Verify Single Sender, within 48 hours.
| Field | What you enter |
|---|---|
| From name, From email | The name and address your portal's email is sent from. |
| Reply to name, Reply to email | Where replies go. |
| Address, Address line 2, City, Country, ZIP / Postal code | A postal address for the sender. State appears for the United States and takes two letters. |
The email's Verify Single Sender button holds the link: right-click it to copy the address. If the email does not arrive, choose Resend Verification. Once verified, Send a test email appears.
Which emails can you customize?
The Templates list holds built-in notification templates that Apiable sends automatically, and any templates you add. Invitation and sign-in emails are not in the list and keep fixed wording.
| When it is sent, and to whom | |
|---|---|
pipeline_enrollment | A team is enrolled in a plan's sandbox. To the team's members. |
pipeline_changes_requested | You ask a team for changes before production. To the team's members. |
pipeline_approved, pipeline_rejected | You approve or reject a team for production. To the team's members. |
pipeline_submitted | A team submits for production review. To the plan's approval group, or the default approval group. |
scope_grant_requested | A developer requests a scope. To the plan's approval group, or the default approval group. |
scope_grant_approved, scope_grant_declined, scope_grant_revoked | A scope grant is decided or revoked. To the subscription's owner. |
| Any other template, including ones you add | Chosen when you publish a new version of a plan and notify its subscribers. Only active templates are offered. |
Invitation emails use fixed wording, with the logo, button colours and footer link from Theme, Email Settings. See Scope grants and From sandbox to production for the events themselves.
How do you edit a template?
Open Settings, Portal settings, Templates. The Email templates list shows each template's Name and Subject. Choose Edit on a row, or + Add new template, change the fields, and choose Save Changes.
| Field | What it sets |
|---|---|
| Active | Whether the template can be sent. |
| Name* | The template's name. Keep built-in names unchanged. |
| Subject* | The subject line you set for the email. |
| Variables | Records which variables the template uses, such as PRODUCT_NAME. |
| Body | The message. Markdown formatting is turned into HTML when you save. |
Write a variable in double braces in the Subject or Body, for example {{GIVEN_NAME}}. Each email fills in the values it has, and a placeholder it does not supply stays as written. The variables are GIVEN_NAME, FAMILY_NAME, EMAIL, TEAM_NAME, PLAN_NAME, PRODUCT_NAME, SUBSCRIPTION_NAME, SUBSCRIPTION_LINK and PORTAL_NAME.
Send a test email appears for active templates. Delete on a row removes the template at once, without asking.
How do you set up the contact form?
In Templates, the Form Templates section sets where contact form messages go and the legal text under the form. Enter both and choose Save Changes. A form placed with the contactForm tag only works once a recipient is saved.
| Field | What it sets |
|---|---|
| Recipient Email Address for form submissions | The address that receives each message. It must be a valid email address. |
| Form Legal Text | Text shown below the form, such as a privacy statement. |
Each message arrives with the subject "Contact Form Submission:" followed by the subject the visitor typed, and replying goes to the visitor. See Markdoc components to place the form.
Troubleshooting
| What you see | What to do |
|---|---|
| "Please upgrade to access this feature" | Your plan does not include custom email. Talk to sales. |
| "Email address must be from the domain" | Use a sending address on the domain you entered. |
| "Failed to verify domain, please check the DNS records." | Check each record at your DNS provider, wait for the change to spread, and choose Verify again. |
| "There is no email sender identity configured. Please configure an email sender identity before creating email templates." | Verify a domain or single sender under Email Sender Identity first. |
| A notification stopped arriving | Check that its built-in template still exists, keeps its exact Name, and is Active. |
| Contact form messages fail | Save a recipient under Form Templates. |
| "Invalid email format" in Form Templates | Enter a complete address, for example contact@example.com. |