Method parameters
DeleteList method allows to delete one or more lists in MailUp, with all the related data.
- string DeleteList(string accessKey, int listId, stringautoId)
- accessKey: access key obtained using the Login method
- listId: list identifier
- autoId: identifier which allows MailUp to know if a list was created in an automated context or not. In the Microsoft Dynamics CRM it corresponds to the ORGUNIQUENAME.
Parameters autoId e listId can be used together or alternatively; the following scenarios are possible:
- If listId value > 0, the corresponding list is deleted. Values provided via autoId are ignored.
- If listId value =< 0 and autoId is defined, all the lists associated to the external identifier provided via autoId are deleted.
Sample DeleteList response
<DeleteList> <Lists> <List Id ="X"/> </Lists> </DeleteList >
The XML string will have the following features:
- A root node <DeleteLists>.
- A node <Lists>, contained in the root node.
- A node <List> with the Id attribute containing the identifier of the deleted list
In case of errors during the creation of the list, the XML will have the following structure:
<DeleteList> <Error>"Messaggio di errore"</Error> </DeleteList >
The XML string will have the following features:
- A root node <DeleteList>.
- A node <Error>, contained in the root node, returning the error message.