Read your email and SMS credit balance, contact fields, email and SMS sending profiles and executive reports, and manage content categories.
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 |
|---|---|---|
GET | /api/ | Get email and SMS credit balance |
GET | /api/ | Get the account contact fields filtered by fields' type |
GET | /api/ | Get the account emails sending profiles |
GET | /api/ | Get the account Sms sending profiles |
GET | /api/ | Check if the account has awaited merges |
GET | /api/ | Get the account's ActiveCommerce integration data |
GET | /api/ | Get the account's categories |
GET | /api/ | Get a specific category details by providing its ID |
PUT | /api/ | Update a specific category details by providing its ID |
POST | /api/ | Create a new category |
DELETE | /api/ | Delete a specific category by providing its ID |
GET | /api/ | Get executive reports |
GET | /api/ | Get inactive and active contacts' daily growth filtered by dates |
Endpoint details
Get email and SMS credit balance
GET https://webapi.mymarketing.co.il/api/account/balance
No parameters.
Full reference, request and response samples
Get the account contact fields filtered by fields' type
GET https://webapi.mymarketing.co.il/api/account/contactFields
| Parameter | In | Type | Description |
|---|---|---|---|
fieldsType | query | UserFieldObjectTypes |
Full reference, request and response samples
Get the account emails sending profiles
GET https://webapi.mymarketing.co.il/api/account/sendingprofiles
No parameters.
Full reference, request and response samples
Get the account Sms sending profiles
GET https://webapi.mymarketing.co.il/api/account/sms-sendingprofiles
No parameters.
Full reference, request and response samples
Check if the account has awaited merges
GET https://webapi.mymarketing.co.il/api/account/merge
No parameters.
Full reference, request and response samples
Get the account's ActiveCommerce integration data
GET https://webapi.mymarketing.co.il/api/account/integrationdata/activecommerce
No parameters.
Full reference, request and response samples
Get the account's categories
GET https://webapi.mymarketing.co.il/api/account/contentCategories
No parameters.
Full reference, request and response samples
Get a specific category details by providing its ID
GET https://webapi.mymarketing.co.il/api/account/contentCategories/{id}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Category id. Can be found using the endpoint "Get the account's categories." Required. |
Full reference, request and response samples
Update a specific category details by providing its ID
PUT https://webapi.mymarketing.co.il/api/account/contentCategories/{id}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Category id. Can be found using the endpoint "Get the account's categories." Required. |
name | body | string | Category name |
display_order | body | integer | Display Order |
is_default | body | boolean | If the Category is Default |
The request body is a JSON object (ApiContentCategoryUpdate).
Full reference, request and response samples
Create a new category
POST https://webapi.mymarketing.co.il/api/account/contentCategories
| Parameter | In | Type | Description |
|---|---|---|---|
name | body | string | Category name |
display_order | body | integer | Display Order |
is_default | body | boolean | If the Category is Default |
The request body is a JSON object (ApiContentCategoryPost).
Full reference, request and response samples
Delete a specific category by providing its ID
DELETE https://webapi.mymarketing.co.il/api/account/contentCategories/{id}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Category id. Can be found using the endpoint "Get the account's categories." Required. |
Full reference, request and response samples
Get executive reports
GET https://webapi.mymarketing.co.il/api/account/executivereport
No parameters.
Full reference, request and response samples
Get inactive and active contacts' daily growth filtered by dates
GET https://webapi.mymarketing.co.il/api/account/executivereport/contactgrowth
Get inactive and active contacts' daily growth filtered by dates (from/to date, the default is three months back)
| Parameter | In | Type | Description |
|---|---|---|---|
from_date | query | date | The first date the contacts you want were created. Format: yyyy-mm-dd. |
to_date | query | date | The last date the contacts you want were created. Default: the last 3 months. Format: yyyy-mm-dd. |
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.