Method :POST
URL: https://apiv1.publicators.com/api/Recipients/CancelFutureEventTypeCampaignsForRecipient
Enables you to cancel existing scheduled email/s that were set by an event type campaigns.
Request Information
URI Parameters
None.
Body Parameters
CancelFutureEventTypeCampaignsForRecipientBindingModelName | Description | Type | Additional information |
---|---|---|---|
Auth | AuthorizationTokenBindingModel |
Required |
|
CampaignId |
Campaign ID. In a case of null - Cancel all waiting launches from all event type campaigns |
integer |
None. |
Recipient Email. Max length: 100 characters long. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "Auth": { "Token": "3496c8b2-6e04-4a82-b78d-ca818af7bdf9" }, "CampaignId": 1, "Email": "sample string 1" }
Response Information
Resource Description
CancelFutureEventTypeCampaignsForRecipientViewModelName | Description | Type | Additional information |
---|---|---|---|
Affected |
Number of canceled |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Affected": 1 }