Create and manage API keys

An API key lets your tools call Upsellr’s public API on behalf of your organization. API access is reserved for the Enterprise plan.

Where to find the keys

Open the account menu, then Manage and API & webhooks. On any plan other than Enterprise, the section shows “Included in the Enterprise plan” and a button to change plan.

Create a key

1. Click Create API Key.
2. Give it a Name that says what it is for, for example the name of the tool that uses it.
3. Choose a Scope preset:
   • Read only: read channels, products, sources, workflows, members and the organization.
   • Read & Write: everything, except launching workflows.
   • Full access: all scopes, including launching workflows.
   • Custom: tick the scopes you want one by one.
4. Choose the Expiration: 7 days, 30 days, 90 days, 1 year, 3 years, No expiration, or a custom duration of 1 to 1,095 days.
5. If needed, fill in the Allowed IPs and the Allowed User-Agents, separated by commas.
6. Click Create Key.

The key is shown only once. Copy it and keep it in a safe place before closing the window.

The available scopes

Resource	Scopes
Channels	Create, read, edit, delete
Products	Create, read, edit, delete
Sources	Read, upload source files
Workflows	Read, launch
Organization	Read the organization, read the members

Revoke a key

In the list, click Revoke next to the key. Any integration that uses it stops working immediately. This action is irreversible.

Good to know

• Only owners and admins create and revoke keys. Members see them read-only.
• The list shows each key’s scopes, its expiry date and its Last used date: a key that has never been used is often a key to revoke.
• Launching a workflow can involve many products and credits. Only give the launch scope to the integrations that need it.
• Create one key per integration, with only the scopes it needs.
• A lost key cannot be shown again: revoke it and create a new one.