API keys and AI agent rules
Create keys for apps and AI agents, limit mailboxes and permissions, add agent rules, and pause or revoke a key.
An API key is like a password for software: it lets an app, script or AI agent use chosen mailboxes without anyone signing in. It is shown once when created. Manage keys in Admin, API keys.
Create a key
- Choose Create API key.
- Enter a Name you will recognise later, like "CRM sync" or "Invoice agent". Agent actions are logged under this name.
- Under Mailboxes, pick the only mailboxes the key can reach. Pick as few as the app needs. Anyone holding the key can use these mailboxes within the permissions, without a password or two-factor.
- Under Permissions, give only what the app needs: Read messages and folders, Send mail, and Move, flag and delete messages. A reporting tool needs just Read.
- If it is for an AI agent, switch on This key is for an AI agent to add rules (below).
- Choose Create key, then copy the key. It is sent in the Authorization header as
Bearer <key>.
Agent rules
Rules are enforced by PGB Business itself, on top of permissions. A set of ready-made starting points fills in the details, and you can adjust them (which switches to Custom).
What it may read. Mail outside these limits is invisible to the agent. Limit by folder and by sender addresses or domains, for example only the inbox and mail from vendor.com.
What it may send. A message that breaks any of these is "outside the rules":
- Recipients: Anyone, Known contacts only, People in this workspace only, or Only these domains. Every recipient (To, Cc, Bcc) must qualify.
- Most recipients per message, to stop accidental mass mailing.
- Messages per day. Days start at midnight UTC.
- Quiet hours: a daily window, for example 20:00 to 07:00 in a time zone, when anything the agent sends is held or refused.
When a message is outside the rules: Refuse anything outside the policy, Hold anything outside the policy for approval, or Hold every message for approval. Held messages wait in Approvals.
Choose Save rules. Changes apply within a minute. Messages already held keep waiting.
Pause or revoke
Each key's row has Pause (stops it until you resume it) and Revoke. Revoking stops apps using that key right away and cannot be undone. Revoke any key you no longer use or that may have leaked. Edit rules changes an agent key's rules later.
Tips
- One key per app, so you can revoke one without breaking others.
- For anything an agent sends to customers, start with Hold every message for approval.
More guides in Workspace administration
A tour of Admin for workspace administrators
What each Admin tab does, how usage and limits are shown on Overview, and where to start with a new workspace.
Create and manage users and mailboxes
Create mailboxes, add aliases and shared mailboxes, reset passwords, pause sending, suspend or delete, and understand what counts toward your plan.
Plan, billing, storage and add-ons
Read your limits, change plan, pay a term from the wallet, add storage or add-ons, and ask for a higher limit.
Set the workspace security policy
Require two-factor, control public links and outside sharing, allow self-service password reset, and review who has set up protection.
Set up single sign-on with your identity provider
Connect OpenID Connect or SAML, test it, turn it on, require it, and keep break-glass administrators.
Export workspace data
Download a full copy of mail, files, documents and more as ZIP parts, and what to do with it.