For more information on using API
GET http://webapi.mymarketing.co.il/api/campaigns/{id}/segment
Get campaign sending settings (groups and sending restrictions)
Request Information
URI Parameters
Name
Description
Type
Additional information
id
Campaign id
integer
Required
Body Parameters
None.
Response Information
Resource Description
Name
Description
Type
Additional information
limit_amount
Limit the number of emails
integer
limit_per_hour
Limit the number of emails to send per hour
integer
last_days_not_received
Send only to users who have not received an email in the specified number of days
integer
groups_excluded_ids
Restrict the sending of the campaign to users who are not related to the following groups
Collection of integer
not_opened_campaign_ids
Restrict he sending of the campaign to users who have not received the following emails
Collection of integer
not_received_campaign_ids
Restrict to users that have not opened the following emails
Collection of integer
sub_account_id
Send to contacts that are in a specific sub account using the sub account id
integer
group_ids
List of groups that will recieve the campaign
Collection of integer
Required
mailing_list_id
The list of recipients who will recieve the campaign
integer
Response Formats
application/json, text/json
Sample:
{
"limit_amount": 1,
"limit_per_hour": 1,
"last_days_not_received": 1,
"groups_excluded_ids": [
1,
2
],
"not_opened_campaign_ids": [
1,
2
],
"not_received_campaign_ids": [
1,
2
],
"sub_account_id": 1,
"group_ids": [
1,
2
],
"mailing_list_id": 1
}
application/xml, text/xml
Sample:
<ApiCampaignRestrictionsSegment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
<group_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</group_ids>
<mailing_list_id>1</mailing_list_id>
<groups_excluded_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</groups_excluded_ids>
<last_days_not_received>1</last_days_not_received>
<limit_amount>1</limit_amount>
<limit_per_hour>1</limit_per_hour>
<not_opened_campaign_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</not_opened_campaign_ids>
<not_received_campaign_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</not_received_campaign_ids>
<sub_account_id>1</sub_account_id>
</ApiCampaignRestrictionsSegment>