Follow

Delete List

The Delete List command allows you to permanently delete an existing List.

DELETE /lists/[listId]

https://[siteurl]/rest/lists/[listId]

Request Body Parameters

The Delete List command requires the List ID defined within the URI in order to delete any type of List. No additional fields are required in the JSON. Delete cannot be undone.    

Request Body Example

Using Delete List, line breaks in JSON for readability:

curl --request DELETE \ 
--url 'https://mail.mydomain.com/rest/lists/10' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'accept: application/vnd.whatcounts-v1+json' \
--include

Response Body

The response returns an HTTP status code only with no additional JSON.  Based on the example above, the response returns:


HTTP/1.1 204 NO CONTENT
Server: serverName
Content-Type: application/json
Content-Length: 6
Link: <https://mail.mydomain.com/rest/lists/10>;
Date: Fri, 17 Jun 2016 12:54:44 GMT
{
}

Error Response

Error Response Codes include both Client Errors (4xx) and Server Errors (5xx).  Descriptions of each can be found in Response Codes

For example, if the List does not exist, the error would appear as:

{
"error": "Delete Failed: Unable to find resource to delete"
"status": "Not Found"
"statusCode": 404
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk