Send WhatsApp campaigns and operational messages, and read your WhatsApp profiles, approved templates and 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
| Method | Endpoint | What it does |
|---|---|---|
POST | /api/ | Create and send a new WhatsApp campaign |
POST | /api/ | Create and send a new WhatsApp operational message |
GET | /api/ | Get all WhatsApp profiles for the account |
GET | /api/ | Get all approved WhatsApp templates for the user |
GET | /api/ | Get a specific WhatsApp template by ID (Sid) |
GET | /api/ | GET /api/v2/WhatsAppCampaign |
GET | /api/ | GET /api/WhatsAppCampaign |
GET | /WhatsAppCampaign/ | GET /WhatsAppCampaign/GetCampaignContent |
Endpoint details
Create and send a new WhatsApp campaign
POST https://webapi.mymarketing.co.il/api/whatsappcampaign/SendCampaign
Create and send a new WhatsApp campaign. The first message to a contact must be an approved template, with nothing else. Free text and attachments can be sent only within 24 hours of the contact's last reply; otherwise the message fails. Create the template in ActiveTrail first; WhatsApp must approve it before you can send it.
| Parameter | In | Type | Description |
|---|---|---|---|
scheduling | body | ApiPostWhatsAppScheduling | |
segment | body | ApiPostWhatsAppSegment | |
details | body | ApiPostWhatsAppDetails | |
design | body | ApiPostWhatsAppDesign | |
template | body | ApiPostWhatsAppTemplate |
The request body is a JSON object (ApiWhatsAppCampaignSendCampaignContainer).
Full reference, request and response samples
Create and send a new WhatsApp operational message
POST https://webapi.mymarketing.co.il/api/whatsappcampaign/SendOperationalMessage
Create and send a new WhatsApp operational message. The first message to a contact must be an approved template, with nothing else. Free text and attachments can be sent only within 24 hours of the contact's last reply; otherwise the message fails. Create the template in ActiveTrail first; WhatsApp must approve it before you can send it.
| Parameter | In | Type | Description |
|---|---|---|---|
scheduling | body | ApiPostWhatsAppScheduling | |
segment | body | ApiPostWhatsAppGroupsSegment | |
details | body | ApiPostWhatsAppDetails | |
design | body | ApiPostWhatsAppDesign | |
template | body | ApiPostWhatsAppTemplate |
The request body is a JSON object (ApiWhatsAppCampaignSendOperationalMessageContainer).
Full reference, request and response samples
Get all WhatsApp profiles for the account
GET https://webapi.mymarketing.co.il/api/whatsappcampaign/profiles
No parameters.
Full reference, request and response samples
Get all approved WhatsApp templates for the user
GET https://webapi.mymarketing.co.il/api/whatsappcampaign/templates
No parameters.
Full reference, request and response samples
Get a specific WhatsApp template by ID (Sid)
GET https://webapi.mymarketing.co.il/api/whatsappcampaign/templates/{id}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | string | Template ID (Sid) Required. |
Full reference, request and response samples
GET /api/v2/WhatsAppCampaign
GET https://webapi.mymarketing.co.il/api/v2/WhatsAppCampaign
This endpoint has no description in the ActiveTrail API documentation yet.
| Parameter | In | Type | Description |
|---|---|---|---|
content | query | string | Required. |
templateSid | query | string | Required. |
Full reference, request and response samples
GET /api/WhatsAppCampaign
GET https://webapi.mymarketing.co.il/api/WhatsAppCampaign
This endpoint has no description in the ActiveTrail API documentation yet.
| Parameter | In | Type | Description |
|---|---|---|---|
content | query | string | Required. |
templateSid | query | string | Required. |
Full reference, request and response samples
GET /WhatsAppCampaign/GetCampaignContent
GET https://webapi.mymarketing.co.il/WhatsAppCampaign/GetCampaignContent
This endpoint has no description in the ActiveTrail API documentation yet.
| Parameter | In | Type | Description |
|---|---|---|---|
content | query | string | Required. |
templateSid | query | string | Required. |
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.