Portal details and registration

Your API Portal carries its own name, sign-up rules, and registration form. You set these in the dashboard under Settings, in the portal details section. From here you control how developers register, whether sign-ups need approval, what they agree to, and what extra details you collect.

Where do you set the portal name and registration?

Open Settings in the dashboard and go to the portal details section. Each setting is its own block with its own Save changes button, so you save one change at a time.

1. Open Settings in the dashboard.
2. Go to the portal details section.
3. Edit a block, for example the portal name or the approval group.
4. Choose Save changes on that block.

Each block saves independently. A block's Save changes button enables only when you have changed that block's value, so a half-typed support email or an unchanged approval group leaves its button disabled.

How do you change your API Portal name?

Edit the portal name field in the portal details section and choose Save changes. The new name applies to your portal and updates across the dashboard. The block also shows your portal's address, in the form your-tenant.apiable.io.

The portal name is the display name developers see. Changing it does not change your portal's web address. To point a custom domain at the portal instead of the default .apiable.io address, see Custom domain.

How does registration approval work?

Set a registration approval group to make new sign-ups wait for review. When a developer registers, a member of that group approves or rejects them before the account becomes active. Leave the group empty to let registrations activate without manual approval.

Both are selected from the approval groups defined for your organization, and both can be cleared. To create and manage the groups themselves, set up approval groups at the organization level.

How do you add a terms acknowledgement at sign-up?

The terms acknowledgement block adds a consent checkbox to the registration form. You set the checkbox label, the warning shown if a developer does not tick it, and the link text for the terms. You can add more checkboxes under Extra Acknowledgements.

Under Extra Acknowledgements you add further checkboxes, each with its own label, warning, link text, and a URL such as /terms. Add as many as you need, then choose Save changes for the block.

What extra fields can you collect at registration?

You can collect company details and your own custom fields. A company-details toggle adds company fields to the form. A separate custom properties block lets you define your own fields, each as text, yes/no, or a selection list, with its own required flag.

Custom properties give you a titled section on the form. Its default heading is Additional Details and its default body text is "Almost there! Just a few more questions." For each property you set:

• A name and a generated id you can copy for use elsewhere.
• A type: text, yes/no, or a selection list.
• A required flag.
• For a selection list, the options, a default option, and whether multiple choices are allowed.
• An optional description shown under the field.

Once a property is already in use by registered developers or referenced by a redirect rule, the portal disables it instead of deleting it, so existing data is preserved. A property that is not in use can be deleted outright.

How do you block sign-ups from personal email addresses?

Turn on the prohibit-public-email-signup toggle in the portal details section, then choose Save changes. Sign-ups from public email domains are then blocked, so only business email addresses can register.

This is useful when your APIs are for business partners rather than the general public. It pairs with team domains, where you can group developers who share an email domain into the same team and, optionally, prevent them from creating separate teams when a matching domain team already exists.

How do you set the support email and default product tab?

The support email field sets the contact address shown to developers. The product default tab setting chooses which tab opens first on a product page. Both are in the portal details section and each saves on its own.

The product default tab decides what a developer sees first on every product: the overview (details), the available plans (plans), or the API documentation (documentation). Choose plans to push developers toward subscribing, or documentation to lead with the API reference.

Troubleshooting

Match what you see to the fix.

Where to next