Exclaimer API

Automatically enabled when you configure Exclaimer permissions in your agent workflow.

What It Does

Read a client’s subscription: status, tier, SKU, trial, licensed and billable users, overage, and its tier and SKU history

Read the mailboxes signed in the last 30 days, and for an MSP account the monthly mailbox and sender usage

Create a subscription, and change its mailbox count, tier, SKU, name or not-for-resale status

End a trial, pause, end or reactivate a subscription

Add, change and remove a client’s portal users and their roles, and change the subscription’s owner

Start, cancel or claim a subscription transfer between Exclaimer partners

Add or update your own client and reseller records

Permission Groups

Group	Covers
Subscriptions	Each client’s subscription, its history, mailbox count and usage, your mailbox allocation, the SKU, tier and data center lists, and every subscription change
End Users & Resellers	Your own Exclaimer records for your clients and resellers
Portal Users	Who can sign in to a client’s Exclaimer portal; adding an Editor, setting a user’s roles to Editor, removing a user
Portal Admins	Giving a user the Admin role, and changing the subscription’s owner (write only)
Subscription Transfers	Starting, cancelling and claiming a transfer between partners (write only)

Access Profiles

Profile	What runs
Read Only	Every read in Subscriptions, End Users & Resellers and Portal Users
Helpdesk	Every read; subscription and portal user changes after a technician approves them; no transfers
IT Admin	Every read and change on its own, except an Admin grant and a transfer, which a technician approves
Full Automation	Every read and change without approval

Safety Controls

Control	Behavior
The ticket’s client only	On a run for a ticket that names a company, Neo sends a call only about the Exclaimer subscription the ticket’s company is mapped to, a new subscription, a transfer claim, or the SKU, tier, data center and mailbox allocation lists. Calls about every client (the subscription and user lists, your client and reseller records) go out only on a run with no ticket company, such as a chat with Neo or a scheduled agent. A body that names one of your client or reseller records is not sent on a ticket run
Admin grants apart	A portal user write that sets any role other than Editor, or roles Neo cannot read, needs the Portal Admins group
Transfer tokens kept out of logs	A transfer token is masked in the run’s stored steps, and a sandbox script cannot start a transfer

What It Does