CookieStore.DeleteCookie

Updated on 14 May 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

Permanently deletes a cookie or multiple cookies.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name	Required	Type	Description
`CookieID`	False*	numeric	Unique identifier of the cookie.
`CookieStoreName`	False	string	The name of the cookie store.
`CookieName`	False	string	The name of the cookie.
`CookieDomain`	False	string	The domain of the cookie.
`CookiePath`	False	string	The cookie path.
`AllMatches`	False	boolean	True to delete all cookies that match the given criteria.

* You can identify the cookie to be deleted with CookieID or with at least CookieStoreNameand CookieName.

Note

If you don't use CookieID and multiple cookies match the parameters while AllMatches=true is not included in the parameters, then an error will be returned.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`CookieStoreID`	numeric	Unique identifier of the cookie store.
`CookieCount`	numeric	The number of cookies deleted.
`CookieID`	numeric	Unique identifier of the cookie.
`CookieName`	string	The name of the cookie.

The result of the operation includes the CookieStoreID and CookieCount. If only one cookie was deleted, then the CookieID and the CookieName will also be included.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=CookieStore.DeleteCookie&CookieStoreName=Lowes%20Cart&CookieName=SetFromApi'

Sample responses

XML - single cookie matched

<?xml version="1.0" encoding="utf-8"?>
<CookieStoreDeleteCookieResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<CookieStoreID>1006</CookieStoreID>
	<CookieCount>1</CookieCount>
	<CookieID>1422</CookieID>
	<CookieName>SetFromApi</CookieName>
</CookieStoreDeleteCookieResponse>

XML - multiple cookies matched

<?xml version="1.0" encoding="utf-8"?>
<CookieStoreDeleteCookieResponse
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<CookieStoreID>1006</CookieStoreID>
	<CookieCount>2</CookieCount>
	<CookieName>SetFromApi</CookieName>
</CookieStoreDeleteCookieResponse>

JSON (add `&ResponseFormat=JSON`) - single cookie matched

{
    "CookieStoreID": 1002,
    "CookieCount": 1,
    "CookieID": 1012,
    "JsonResult": {
        "Command": "CookieStore.DeleteCookie",
        "AutoLoggedIn": false,
        "WebConsoleKey": "",
        "Result": "Success",
        "ErrorCode": "",
        "ErrorDescription": "",
        "ErrorList": [],
        "ExecutionTime": {
            "Ticks": 0,
            "Days": 0,
            "Hours": 0,
            "Milliseconds": 0,
            "Minutes": 0,
            "Seconds": 0,
            "TotalDays": 0,
            "TotalHours": 0,
            "TotalMilliseconds": 0,
            "TotalMinutes": 0,
            "TotalSeconds": 0
        }
    }
}

Was this article helpful?

What's Next

CookieStore.Get