API Portal
SEO and marketing
Set your API Portal's SEO title, meta and Open Graph tags, and social preview, and connect Google Tag Manager. All from Settings, Portal Settings, Marketing.
The Marketing settings control how your API Portal looks to search engines, social platforms, and analytics. You set the portal title, meta and Open Graph tags, and the social preview in one SEO block, and you connect Google Tag Manager from the same page. To see how the portal fits together, start with the API Portal overview.
Where do you set SEO and marketing for your API Portal?
Open Settings, then Portal Settings, then Marketing. The Marketing page holds two blocks: Google Tag Manager and SEO. The SEO block covers the portal title, meta tags, Open Graph tags, and the social preview.
| Block | What it controls |
|---|---|
| Google Tag Manager | The Google Tag Manager container that loads on your portal. |
| SEO | The meta and Open Graph properties, plus the portal title used in search results and browser tabs. |
How do you set the API Portal page title?
In the SEO block, edit the Portal title field, then choose Save changes. The field defaults to API Portal. Your title is used in the browser tab and as the page title search engines read.
- Open Settings, then Portal Settings, then Marketing.
- Scroll to the SEO block.
- In Portal title, type the title you want. It starts as API Portal.
- Choose Save changes. The button enables once the title changes.
How do you add meta and Open Graph tags?
In the SEO block, each row is a meta property and its content. The block starts with four Open Graph rows: og:title, og:description, og:url, and og:image. Edit the values, add rows for more properties, then save.
| Field | What you enter |
|---|---|
| Property (left) | The meta or Open Graph property name, for example og:title or og:image. |
| Content (right) | The value for that property, for example your portal name or an image URL. |
To add another property, use the add-property control under the rows. To remove a row, use the cross icon at its end. Choose Save changes when you are done. The button enables once a property or the title changes.
How do you connect Google Tag Manager?
In the Google Tag Manager block, paste your container ID, then choose Save changes. The ID has to start with GTM-. The save button stays disabled until the ID starts with GTM- and differs from the value already saved.
- Open Settings, then Portal Settings, then Marketing.
- In Google Tag Manager, paste your container ID, for example
GTM-XXXXXXX. - Choose Save changes. The button enables once the ID starts with
GTM-.
Why is the Google Tag Manager save button disabled?
The button only enables when the ID starts with GTM- and is different from the saved value. A common cause is pasting a Google Analytics measurement ID instead of a Google Tag Manager container ID.
| What you see | What to check |
|---|---|
| Save changes stays disabled | The ID does not start with GTM-. Paste the container ID, for example GTM-XXXXXXX. |
| Save changes stays disabled after editing | The ID matches the value already saved. No change means nothing to save. |
Where to next
API Portal overview
How pages, theme, navigation, and settings make up your portal.
Custom CSS and Markdoc partials
Style the portal with CSS and reuse content blocks across products.
Custom domain
Serve your portal on your own domain with a verified CNAME.
Email domain and templates
Send portal email from your own authenticated domain.