 | Cloud Fax and Notifications API 2.5 Documentation CampaignDelete | Cloud Fax and Notifications API Forums Home |
9.2 CampaignDeleteRequest | CampaignDelete Overview CampaignDeleteResult |
In order to delete a form, both the form name and the name of the campaign to which it belongs must be specified. If the intent is to delete the campaign, then no FormName should be included in the request.
A campaign that still contains at least one form cannot be deleted unless deleteEntireCampaign attribute is present and set to "true", which indicates that all the forms are to be deleted along with the campaign.
| Tag Name & type | # | Description | |||
|---|---|---|---|---|---|
| CampaignDeleteRequest | Namespace of this element is http://ws.easylink.com/CampaignDelete/2011/01 | ||||
| SubmitId xs:string | 0-1 | Optional string identifying request, which will be echoed in result. | |||
| Domain xs:string | 1 | The EasyLink domain to which the request should be sent. Legal values are XDDS or MR, or the actual name of a domain. Using an actual domain name is discouraged, since using the generic values allows EasyLink to consider all currently accessible switches. | |||
| Campaign CampaignFormPairType | 1- | This element specifies the campaign or form to deleted. | |||
| CampaignName | 1 | Name of the campaign to be deleted or, if a form (rather than the campaign) is to be deleted, the name of the campaign to which the form belongs. | |||
| @deleteEntireCampaign xs:boolean | 0-1 | If this attribute is present and set to true then the campaign along with all the forms present in it will be deleted. If this flag is false (the default) and no FormName is provided, an error will be returned if the campaign is not empty. | |||
| FormName xs:string | 0-1 | Name of the form to be deleted. If no FormName is provided, the request is treated as a request to delete a campaign. | |||
| © Copyright 2020 OpenText Corp. All Rights Reserved. Privacy Policy | Cookie Policy |
This information is subject to change. Please check frequently for updates. Modified October 06, 2020 |