Delete stored content
https://api.alert.alertinghub.co.uk/api/json/deletecontent
Use this API to easily delete previously stored content. You can delete specific stored items or all items of a particular type or even all items in one go.
{ "version": "latest", "apiKey": "abcdefghijklmnopqrstuvwxyz", "content": [ { "tag": "t1", "storeId": "83de6bd5-230c-479e-8e4e-bf7d8b1e27bd" } ] }
Deleting stored content
Parameter | Requirement | Default | Description | |
---|---|---|---|---|
version | Mandatory | None | See API guide | |
apiKey | Mandatory | None | See API guide | |
content | Optional | Array of items to be deleted | ||
storeId | Mandatory | None | The unique id of a stored item OR the value 'all' to delete all items of the given contentType. | |
contentType | Mandatory (if storeId is set to 'all') | None | The type of content to which the storeId refers. One of "call","sms", "email","inboundCall","recipientList", "contactGroup", "contactList" or "contactSetList". Not required if a single storeId is given. | |
tag | Mandatory (if storeId is a single stored item) | None | Client defined tag - freeform used in the response. | |
all | Optional | false | If set to true then all content owned by your API key will be deleted. Use carefully! |
Response
Parameter | Description | |
---|---|---|
success | One of “true”, “false”. If false then failureReason should also be returned | |
content | Array of items processed | |
success | One of “true”, “false”. If false then failureReason should also be returned | |
storeId | The stored item that was deleted (if a single deletion). | |
deletedStoreIds | Array of stored items that were deleted (if an 'all' style delete was requested). | |
contentType | Type of content as per api call | |
tag | Client defined tag as per api call if applicable. |