Developer platform

Build on BorakDesk

A REST API over contacts, campaigns and automation flows. Your users connect your app in one click and choose exactly what it can reach — no API keys to copy and paste.

Machine-readable: OpenAPI 3.1 document (raw JSON — point your client generator at it)

Stable by contract

/v1 is a promise, not a version number. It gains fields and endpoints; it does not remove one, rename one, or change a type. Whatever you build against keeps working.

OAuth, not pasted keys

Your users click Connect and pick the scopes and the Brand. You never ask them for a secret, and they can disconnect you without breaking anything else they use.

Generated from the code

The OpenAPI document is built from the same functions that serialize the responses, so it cannot drift from what the API actually returns.

Start with one request

Any BorakDesk account can create an API key from Admin Center → API Keys. That is enough to read your own data and see the shapes before you write anything.

curl https://api.borakdesk.com/api/v1/contacts?limit=1 \
  -H "Authorization: Bearer brd_live_..."

A key belongs to one Brand and only sees that Brand's data. It also reaches one region — the one its data lives in — so an account spanning regions uses one key per region.

What an app can reach

Ask for the narrowest set that does the job. The consent screen shows every scope in plain words and marks the ones that delete or send, so a request for more than you need is a request your users can see.

contacts.readSee contacts

contacts.writeCreate and update contacts

contacts.deleteDelete contacts

campaigns.readSee campaigns and their results

campaigns.writeCreate and edit draft campaigns

campaigns.sendSend campaigns to an audience

campaigns.deleteDelete draft campaigns

flows.readSee automation flows

flows.enrollAdd contacts to automation flows

Register an app

Create a free developer account and register an OAuth app in a couple of minutes. You get a client ID and secret straight away and can build against them immediately — review is only needed before other people can install it.

A developer account is free and separate from a BorakDesk subscription — no plan, no trial, no bill. Publishing an app does not make you a customer.