API Access
Create, rotate, revoke, and remove API access for integrations that connect to your CMS Max site.
Overview
Use the API screen when you need to connect your site to an external system such as an integration, automation tool, or custom application.
Each API entry has one current token. If you rotate the token, the old token stops working immediately and you must update the integration with the new one.
Only users with the Admin role can use the API screen. Editor and Viewer users do not see Settings > API, and they cannot create, rotate, revoke, or delete API entries there. On the Zapier and AI Connect plugin pages, only Admin users can see or regenerate the token.
Any user who can open the plugins list can install Zapier or AI Connect, but only Admin users see Deactivate, Activate, and Uninstall on those two plugin pages. Deactivating Zapier stops Zaps from being set up, tested, or turned on or off, but Zaps that are already on keep running. To stop a Zap, turn it off in Zapier or uninstall the plugin. Deactivating AI Connect pauses agents connected through Connect. Uninstalling revokes the plugin's token. Installing it again creates a new token that only an Admin can view. Only Admin users can approve an AI Connect (MCP) connection, and a connection works only while the admin who approved it has the Admin role. Anyone holding a token can change your site content through the API, so give the Admin role only to people you trust with that access.
Opening API Access
- In the admin panel, go to Settings > API.
- Review the list of existing API entries.
The list shows whether each entry has an active token, when the token was created, when it was last used, and when it expires.
Creating a New API Entry
- Go to Settings > API.
- Click New API.
- Enter a name that clearly identifies the integration.
- Choose Initial Token Expiration.
- Leave Allow Bulk Destructive Actions off unless the integration needs to erase collections of data or archive products in bulk.
- Click Create.
After the entry is created, CMS Max shows the token once. Add that token to the external system right away.
Exception: if you create an entry named Zapier, CMS Max always creates that token without expiration.
Important: You cannot reopen the same token value later. If you lose it, rotate the token and use the new one instead.
Rotating a Token
- Go to Settings > API.
- Find the API entry you want to update.
- Click Rotate Token.
- Choose the new expiration option.
- Choose whether to enable Allow Bulk Destructive Actions (off by default).
- Confirm the action.
- Copy the new token and update the external system.
Rotating replaces the current token immediately. Any app still using the previous token will stop working until you update it.
Exception: the Zapier API entry does not allow an expiration choice when rotating. Zapier tokens always use No expiration.
Revoking a Token
- Go to Settings > API.
- Find the API entry you want to disable.
- Click Revoke Token.
- Confirm the action.
Revoking removes the current token but keeps the API entry itself. This is useful if you want to temporarily disable access without removing the entry name or its settings.
After revoking, the entry will show no current token until you rotate or create a new one.
Deleting an API Entry
- Go to Settings > API.
- Find the API entry you no longer need.
- Click Delete.
- Confirm the action.
Delete removes the entry itself. Use this when the integration is no longer needed at all.
Exception: the Zapier API entry cannot be revoked or deleted while the Zapier plugin is still installed. Use the Zapier plugin page if you want the plugin-specific token management flow.
Allowing Bulk Destructive Actions
Allow Bulk Destructive Actions is off by default when creating or rotating a token. The Bulk Destructive Actions column shows Blocked or Allowed for the current token.
Keep it off for routine integrations. Individual record deletion and cache clearing remain available. Enabling it permits:
- Permanent data purges and bulk product archiving.
- Archiving a page or category with its entire subtree.
- Deleting a variant or option used by products, which can permanently delete their variations. Unused variants/options remain deletable when permission is off.
- Deleting multiple images in one request.
- Deleting a menu location and all its items, or deleting a menu item with its entire subtree.
- Removing multiple event occurrences in one request.
AI connections made through Connect start with bulk actions blocked. Manage their permission under AI Connect (MCP) > Connected apps > Manage Permissions; this is separate from the API-key permission. Single-image deletion, deleting a menu item while preserving its children, and cancelling one event occurrence remain available.
To change this permission, use Rotate Token, choose the permission, and update the integration with the replacement token. Rotation defaults to blocked even if the previous token allowed bulk destructive actions. Existing tokens without an explicit opt-in are blocked.
Warning: A data purge permanently deletes entire collections of records. An image purge removes media across your site, including files used outside the store. These operations cannot be undone from the admin panel.
What does “purge” mean?
The meaning depends on the action:
- Cache purge: clears cached copies so they can be rebuilt. It does not delete your pages, products, or uploaded media.
- Data purge: permanently removes selected collections of records and their related data. It is not cache maintenance.
- Purge Logs: deletes the request history shown in API Logs. It does not delete your site content.
Choosing an Expiration
When you create or rotate a token, you can choose:
- No expiration
- 1 day
- 1 week
- 1 month
- 1 year
If a token expires, the connected system will no longer be able to access the API until you rotate the token and update the integration.
Reading the Token Columns
The API list includes these token-related columns:
| Column | What it means |
|---|---|
| Token | Whether the current token is active, expired, or missing |
| Bulk Destructive Actions | Whether the current token allows bulk deletion and archiving |
| Token Created | When the current token was issued |
| Last Used | The last time CMS Max accepted that token on an API request |
| Expires | When the current token will expire, or whether it has no expiry |
Viewing API Logs
- Go to Settings > API.
- Click API Logs.
Use the logs to review recent API traffic and help troubleshoot failed or unexpected requests. API Logs is Admin-only like the rest of the API screen: Editor and Viewer users do not see it in the menu and cannot open it, purge logs, or switch API logging on or off.
Gift card codes show as [REDACTED] in the logs of gift card requests, because anyone with a code can spend the card.
Common Situations
A client exists but shows no token
This usually means the token was revoked. Rotate the token to issue a new one.
An integration suddenly stopped working
Check these first:
- The token may have expired.
- The token may have been rotated and the external system still has the old one.
- The token may have been revoked.
I need to replace a token without deleting the API entry
Use Rotate Token. This keeps the entry and replaces only the current token.