Send operational (transactional) email messages to individual email addresses or contacts, up to 500 messages per call, and read the classification list. Operational SMS messages are in API reference: SMS campaigns.

All endpoints use the base URL https://webapi.mymarketing.co.il and an API key in the Authorization header. New to the API? Start with Get started with the ActiveTrail API.

Endpoints

MethodEndpointWhat it does
GET/api/OperationalMessage/ClassificationGet classification list
POST/api/OperationalMessage/MessageSend an email operational message to individual emails (limited to 500 messages)
POST/api/OperationalMessage/ContactsSend an email operational message to individual contacts (limited to 500 messages)

Endpoint details

Get classification list

GET https://webapi.mymarketing.co.il/api/OperationalMessage/Classification

No parameters.

Full reference, request and response samples

Send an email operational message to individual emails (limited to 500 messages)

POST https://webapi.mymarketing.co.il/api/OperationalMessage/Message

Send an email operational message to individual emails (limited to 500 messages). The emails will be created as contacts in your account.

ParameterInTypeDescription
email_packagebodyCollection of ApiEmailPackageEmail address with collection of pairs of keys and values per each email. Please note, personalized fields would not work in this endpoint - therefore using pairs is a must if you want costum emails
detailsbodyApiMessageDetailsMessage details Required.
designbodyApiMessageDesignMessage design Required.
bccbodyApiMessageBCCBCC emails

The request body is a JSON object (ApiOperationalMessage).

Full reference, request and response samples

Send an email operational message to individual contacts (limited to 500 messages)

POST https://webapi.mymarketing.co.il/api/OperationalMessage/Contacts

Send an email operational message to individual contacts (limited to 500 messages). The contacts will be created in your account.

ParameterInTypeDescription
ContactPackagebodyCollection of ApiContactPackageEmail address with collection of pairs of keys and values per each email. Please note, personalized fields would work in this endpoint only if you add them as information in the endpoint
DetailsbodyApiMessageDetailsMessage details Required.
DesignbodyApiMessageDesignMessage design Required.
BCCbodyApiMessageBCCBCC emails

The request body is a JSON object (ApiMessageContact).

Full reference, request and response samples

This reference is based on the ActiveTrail API documentation, where you can also test each endpoint with your own API key.