What you can build today
API · REST · developers · API keys · scopes · integration
Everything below works with an API key made in Settings › API keys. Each key carries only the permissions
(scopes) you give it. All routes start with https://dashboard.azimea.com/api/v1; each one links to its page in the
API reference, with request and response examples.
| You want to | Call | Scope |
|---|---|---|
| Add or update one contact, with attributes and consent | POST /contacts |
contacts:write |
| Add or update many contacts at once | POST /contacts/batch |
contacts:write |
| Read contacts, segments and topics | GET /contacts, GET /contacts/{reference}, GET /segments, GET /topics |
contacts:read |
| Erase a person at their request (GDPR) | DELETE /contacts/{reference} |
contacts:erase |
| Tell Azimea what happened in your product (start flows) | POST /events |
events:write |
| Send a transactional email | POST /sending/emails |
emails:send |
| Keep your catalogue (products, plans, services) in Azimea | POST /items, POST /items/batch, DELETE /items/{externalId} |
items:write |
| Read one catalogue item you sent | GET /items/{externalId} |
items:read |
| Define your own contact fields | GET /contact-attributes, POST /contact-attributes, PATCH /contact-attributes/{key} |
contacts:read / contacts:write |
| Read orders (as a list, with filters) | GET /commerce/orders |
orders:read |
| Hear back about deliveries, bounces, complaints, opens and clicks | signed webhooks (not self-service yet) | — |
A flow whose trigger is an event starts when you send that event’s name with the person’s email to POST /events.
Downloads
Section titled “Downloads”- OpenAPI document:
/openapi/public-v1.json— the whole public API, for code generators and API tools. - Postman collection:
/azimea-api.postman_collection.json— import it, then add abearerTokenvariable holding your API key (every request uses it;baseUrlis already set). - For AI assistants:
/llms.txtindexes the docs;/llms-full.txtholds all of them. Every page also exists as Markdown: add.mdto its address, for example/build/authentication.md.