Skip to content
AzimeaDocs
Dashboard

What you can build today

The public API and webhooks that exist today, and what each one is for.

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://api.azimea.com/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 with To, CC and BCC recipients POST /sending/emails emails:send
Send transactional email from software that speaks SMTP smtp.azimea.com, port 587, the key as password emails:send
Check delivery status for each recipient GET /sending/emails/{id} emails:read
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 Set up signed webhooks in the dashboard —

A flow whose trigger is an event starts when you send that event’s name with the person’s email to POST /events.