Skip to content
Azimea Docs

Overview

Azimea API v1

Section titled “Azimea API v1”

Send contacts, events, catalogue items and transactional email from your own systems, and read contacts and orders. Every request carries an API key made in Settings › API keys: Authorization: Bearer azm_live_…. Each key holds only the permissions given to it. Every answer has the same envelope: { isSuccess, value, status, errors, fieldErrors }; an error carries a code, listed in the docs’ error codes catalog.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/api/v1/contact-attributes
POST
/api/v1/contact-attributes
PATCH
/api/v1/contact-attributes/{key}
GET
/api/v1/contacts/{reference}
DELETE
/api/v1/contacts/{reference}
GET
/api/v1/contacts
POST
/api/v1/contacts
POST
/api/v1/contacts/batch
GET
/api/v1/segments
GET
/api/v1/topics
GET
/api/v1/items/{externalId}
DELETE
/api/v1/items/{externalId}
POST
/api/v1/items
POST
/api/v1/items/batch
GET
/api/v1/commerce/orders
POST
/api/v1/events
POST
/api/v1/sending/emails

Authentication

Section titled “Authentication”

ApiKey

Section titled “ApiKey”

An API key from Settings › API keys, sent as a bearer token.

Security scheme type: http

Bearer format: azm_live_…