CookieStore.DeleteCookie

April 30, 2019

Description

Permanently deletes a cookie

Required parameters

CookieID or CookieStoreName and CookieName

Optional parameters

If using CookieID: (None)
If using CookieStoreName and CookieName: CookieDomain, CookiePath, AllMatches (to match and apply to multiple cookies)

Returns

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

If not using CookieID and multiple cookies match the parameters and “AllMatches=true” is not included in the parameters then an error will be returned

Example request url

https://api.mozenda.com/rest?WebServiceKey=C70E1F84-E12B-4e73-B199-2EE6D43AF44E&Service=Mozenda10&Operation=CookieStore.DeleteCookie&CookieStoreName=Lowes%20Cart&CookieName=SetFromApi

Example response single cookie

<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>

Example response multiple cookies

<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>