Flipsnack API
  • API documentation
  • Getting started
  • API status codes
  • API limitations
  • How to get an API key
  • How to sign a request
  • API reference
    • collection.create
    • collection.getCollection
    • collection.update
    • collection.deleteCollection
    • collection.getEmbed
    • collection.getStats
    • collection.getList
    • collection.downloadHTML
    • user.getStats
  • Zapier
    • zapier.getZapierLeadFormSample
Powered by GitBook
On this page
  • Request parameters
  • Response parameters
  • Error codes
  • Examples
  • Request
  • Response
  1. API reference

collection.deleteCollection

Deletes the specified collection. Please note that you only have access to your own collections.

Note: Requests must be made to https://api.flipsnack.com/v1.

Request parameters

Name

Type

Description

apiKey (required)

string

The API key provided for your user. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". If the key is incorrect the request returns the error code "41 - Invalid credentials".

signature (required)

string

action (required)

string

The API method that should be called. In this case the value should be collection.deleteCollection. If it is not specified, the request will return the error code "30 - Missing mandatory parameter".

collectionHash (required)

string

TheThe hash of the collection you want to delete. If you do not specify a collection hash, then the request will return the error code "30 - Missing mandatory parameter".

Response parameters

If the request is successful, The API does not send back data. It only responds with status code "20 - OK".

Error codes

For complete list of error codes and messages go to API status codes section.

Examples

Request

# GET
curl -X GET \
     -G \
     https://api.flipsnack.com/v1/ \
     -d action=collection.deleteCollection \
     -d apiKey=<YOUR-API-KEY> \
     -d collectionHash=d3m0h45h \
     -d signature=<YOUR-REQUEST-SIGNATURE>
<form method="get" action="https://api.flipsnack.com/v1/">
    <input type="hidden" name="action" value="collection.deleteCollection">
    <input type="hidden" name="apiKey" value="<YOUR-API-KEY>">
    <input type="text" name="collectionHash">
    <input type="hidden" name="signature" value="<YOUR-REQUEST-SIGNATURE>">
    <button type="submit">Submit</button>
</form>

Response

{
    "code": 20,
    "status": "OK"
}
Previouscollection.updateNextcollection.getEmbed

Last updated 1 year ago

The signature must be calculated by you and added to the request. See for more information. If the parameter is missing the request will return the error code "30 - Missing mandatory parameter". If the signature is incorrect the request will return the error code "44 - Invalid signature".

How to sign a request