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

MethodEndpointWhat it does
GET/api/account/balanceGet email and SMS credit balance
GET/api/account/contactFieldsGet the account contact fields filtered by fields' type
GET/api/account/sendingprofilesGet the account emails sending profiles
GET/api/account/sms-sendingprofilesGet the account Sms sending profiles
GET/api/account/mergeCheck if the account has awaited merges
GET/api/account/integrationdata/activecommerceGet the account's ActiveCommerce integration data
GET/api/account/contentCategoriesGet the account's categories
GET/api/account/contentCategories/{id}Get a specific category details by providing its ID
PUT/api/account/contentCategories/{id}Update a specific category details by providing its ID
POST/api/account/contentCategoriesCreate a new category
DELETE/api/account/contentCategories/{id}Delete a specific category by providing its ID
GET/api/account/executivereportGet executive reports
GET/api/account/executivereport/contactgrowthGet 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
ParameterInTypeDescription
fieldsTypequeryUserFieldObjectTypes

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}
ParameterInTypeDescription
idpathintegerCategory 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}
ParameterInTypeDescription
idpathintegerCategory id. Can be found using the endpoint "Get the account's categories." Required.
namebodystringCategory name
display_orderbodyintegerDisplay Order
is_defaultbodybooleanIf 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
ParameterInTypeDescription
namebodystringCategory name
display_orderbodyintegerDisplay Order
is_defaultbodybooleanIf 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}
ParameterInTypeDescription
idpathintegerCategory 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)

ParameterInTypeDescription
from_datequerydateThe first date the contacts you want were created. Format: yyyy-mm-dd.
to_datequerydateThe 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.