Bupple
Automate with Bupple

Automate with Bupple

API keys

Make a Bupple API key for Zapier, n8n, Make, Clay or your own code — the workspaces and brands it may use, what it may do, whether it may spend credits — and turn it off.

A key is how another tool proves it may act for you. It is a long secret that starts with bmcp_, and every call sends it in a header: Authorization: Bearer bmcp_…. A key works as you — it can only do what you can do in each workspace you give it — so make one per tool, named after where you use it.

Open Account settings from the menu under your name, then Bupple API. The tab is there only when the Bupple API is switched on for one of your workspaces.

The Bupple API tab: the address of the API and the list of what it can do

The top of the tab gives the Address your tools call (https://api.bupple.io/v1/api) and the address of the full list of what it can do — the OpenAPI document that Zapier, n8n and Make can import. See API reference.

Make a key

The Make a key form with a name, the workspace and brands, what it may do, and Let this key spend credits

  1. Name — where you will use it. For example Zapier — new leads. The name is how you find the key again to turn it off.
  2. Workspaces and brands it may use. Tick a workspace and either All brands (including new ones) or only some brands. Each call names a brand, and that brand's workspace pays for it.
  3. What else it may do. A key can always read your files, brands and automations. Tick more as the tool needs them:
    • Add files and make public links — save files to the Media Library, and share a file by a public link.
    • Make pictures, videos and designs — Imagine's makers, and video and design jobs.
    • Start automations — run an automation now with data. You need to be able to manage automations yourself.
    • Draft posts — draft, schedule and change posts.
    • Edit the Brand Kit — change Brand Kit fields.
  4. Let this key spend credits. Off, the key only sees what costs nothing. On, it can make pictures, videos and designs and run automations with the credits of the workspace each call's brand is in. Each paid call still says its price first.

Press Make key.

Copy it now

The new key shown once, with Copy and I have it

Bupple shows the key once: This is the only time we can show it. We keep no copy — if you lose it, make a new key. Press Copy, paste it into your tool's credentials, then I have it.

Keep a key like a password

Anyone with the key can do what it allows, as you. Paste it into a tool's credential or secret store, never into a shared document, a spreadsheet column or a page's code. In Clay, prefer an account (a saved header) to a header typed into the column, which everybody who can see the table can read.

Your keys

Your keys lists every key you made: its name, the last four characters, Can spend when it may spend credits, the brands it reaches, and when it was last used. Turn off stops it at once — the next call with it is refused. A turned-off key stays in the list, marked Turned off, so you can see what it was.

When a call is refused

Every refusal is a JSON body with a machine word and one sentence:

{
  "error": "unauthorized",
  "message": "A valid Bupple API key is required: send it as \"Authorization: Bearer bmcp_…\". Make one in Bupple under Account settings › Bupple API."
}
StatuserrorWhat it means
401unauthorizedNo key, or a key that is unknown, turned off or expired.
403api_offThe Bupple API is not switched on for this workspace.
403brand_not_allowed, permissionThe key may not use this brand, or may not do this.
400brand_required, bad_request, bad_argumentsThe call is missing a brand, or its body does not fit — the message says what.
404no_such_tool, not_foundNo such tool, or nothing with that id in this brand.
409conflictThe automation cannot start now — it is a draft, switched off or ended.
422failedThe tool ran and refused — for example, not enough credits.
429Too many calls. Wait the seconds in the Retry-After header.