← Tools Reference

ActiveTrail

ActiveTrail integration (Marketing, Communication). Imported from open-connector.

API key14 toolshttps://webapi.mymarketing.co.il/api
GET
active_trail_get_account_balance
Fetch the current ActiveTrail email, SMS, and coupon account balances.

/account/balance

GET
active_trail_list_contacts
List ActiveTrail contacts with optional state, search, date, and pagination filters.

/contacts

6 parameters
ParamTypeRequiredDescription
customer_statestringoptionalThe ActiveTrail CustomerStates filter used by contact list endpoints.
search_termstringoptionalText used to filter ActiveTrail contacts.
from_datestringoptionalOnly include contacts changed on or after this date.
to_datestringoptionalOnly include contacts changed on or before this date.
pageintegeroptionalThe zero-based page number requested from ActiveTrail.
limitintegeroptionalThe maximum number of records to request from ActiveTrail.
GET
active_trail_get_contact
Fetch one ActiveTrail contact by ID.

/contacts/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe ActiveTrail contact ID.
POST
active_trail_create_contact
Create an ActiveTrail contact.

/contacts

15 parameters
ParamTypeRequiredDescription
subscribe_ipstringoptionalThe subscribe IP address recorded for the contact.
statusstringoptionalThe ActiveTrail contact status value.
sms_statusstringoptionalThe ActiveTrail contact status value.
emailstringoptionalThe contact email address.
smsstringoptionalThe contact SMS value.
first_namestringoptionalThe contact first name.
last_namestringoptionalThe contact last name.
anniversarystringoptionalThe contact anniversary timestamp.
birthdaystringoptionalThe contact birthday timestamp.
citystringoptionalThe contact city.
faxstringoptionalThe contact fax number.
phone1stringoptionalThe contact primary phone number.
phone2stringoptionalThe contact secondary phone number.
streetstringoptionalThe contact street address.
zip_codestringoptionalThe contact ZIP or postal code.
PUT
active_trail_update_contact
Update an ActiveTrail contact.

/contacts/{id}

16 parameters
ParamTypeRequiredDescription
idintegerrequiredThe ActiveTrail contact ID.
subscribe_ipstringoptionalThe subscribe IP address recorded for the contact.
statusstringoptionalThe ActiveTrail contact status value.
sms_statusstringoptionalThe ActiveTrail contact status value.
emailstringoptionalThe contact email address.
smsstringoptionalThe contact SMS value.
first_namestringoptionalThe contact first name.
last_namestringoptionalThe contact last name.
anniversarystringoptionalThe contact anniversary timestamp.
birthdaystringoptionalThe contact birthday timestamp.
citystringoptionalThe contact city.
faxstringoptionalThe contact fax number.
phone1stringoptionalThe contact primary phone number.
phone2stringoptionalThe contact secondary phone number.
streetstringoptionalThe contact street address.
zip_codestringoptionalThe contact ZIP or postal code.
DELETE
active_trail_delete_contact
Delete one ActiveTrail contact by ID.

/contacts/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe ActiveTrail contact ID.
GET
active_trail_list_groups
List ActiveTrail groups with optional search and pagination filters.

/groups

3 parameters
ParamTypeRequiredDescription
search_termstringoptionalText used to filter ActiveTrail groups.
pageintegeroptionalThe zero-based page number requested from ActiveTrail.
limitintegeroptionalThe maximum number of records to request from ActiveTrail.
GET
active_trail_get_group
Fetch one ActiveTrail group by ID.

/groups/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe ActiveTrail group ID.
POST
active_trail_create_group
Create an ActiveTrail group.

/groups

1 parameter
ParamTypeRequiredDescription
namestringrequiredThe group name.
PUT
active_trail_update_group
Update an ActiveTrail group name.

/groups/{id}

2 parameters
ParamTypeRequiredDescription
idintegerrequiredThe ActiveTrail group ID.
namestringrequiredThe updated group name.
DELETE
active_trail_delete_group
Delete one ActiveTrail group by ID.

/groups/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe ActiveTrail group ID.
GET
active_trail_list_group_members
List members in an ActiveTrail group with optional filters.

/groups/{group_id}/members

7 parameters
ParamTypeRequiredDescription
group_idintegerrequiredThe ActiveTrail group ID.
customer_statestringoptionalThe ActiveTrail CustomerStates filter used by contact list endpoints.
search_termstringoptionalText used to filter group members.
from_datestringoptionalOnly include members changed on or after this date.
to_datestringoptionalOnly include members changed on or before this date.
pageintegeroptionalThe zero-based page number requested from ActiveTrail.
limitintegeroptionalThe maximum number of records to request from ActiveTrail.
POST
active_trail_add_group_member
Add or update a contact inside an ActiveTrail group.

/groups/{group_id}/members

16 parameters
ParamTypeRequiredDescription
group_idintegerrequiredThe ActiveTrail group ID.
subscribe_ipstringoptionalThe subscribe IP address recorded for the contact.
statusstringoptionalThe ActiveTrail contact status value.
sms_statusstringoptionalThe ActiveTrail contact status value.
emailstringoptionalThe contact email address.
smsstringoptionalThe contact SMS value.
first_namestringoptionalThe contact first name.
last_namestringoptionalThe contact last name.
anniversarystringoptionalThe contact anniversary timestamp.
birthdaystringoptionalThe contact birthday timestamp.
citystringoptionalThe contact city.
faxstringoptionalThe contact fax number.
phone1stringoptionalThe contact primary phone number.
phone2stringoptionalThe contact secondary phone number.
streetstringoptionalThe contact street address.
zip_codestringoptionalThe contact ZIP or postal code.
DELETE
active_trail_remove_group_member
Remove one contact from an ActiveTrail group.

/groups/{group_id}/members/{member_id}

2 parameters
ParamTypeRequiredDescription
group_idintegerrequiredThe ActiveTrail group ID.
member_idintegerrequiredThe ActiveTrail contact ID to remove from the group.