zapier.getZapierLeadFormSample

Returns information about lead form. The information contains sample data about your fields that might be used for integration.

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".
action (required)	string	The API method that should be called. In this case the value should be zapier.getZapierLeadFormSample. If it is not specified, the request will return the error code "30 - Missing mandatory parameter".
collectionHash (required)	string	The hash of the flipbook you wish to get sample data. If you do not specify a flipbook hash, then the request will return the error code "30 - Missing mandatory parameter".

Response parameters

Name	Type	Description
id	number	Your sample data ID
fields	string	Your predefined fields as [key] - value pairs. Example: “Phone Number”: “[phone]”, “Email Address”: “[e-mail]”

Error codes

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

Examples

Request

cURL

# GET
curl -X GET \
     -G \
     https://api.flipsnack.com/v1/ \
     -d action=zapier.getZapierLeadFormSample \
     -d apiKey=<YOUR-API-KEY> \
     -d collectionHash=<YOUR-COLLECTION-HASH>

HTML

Response

JSON

{
    "data": {
        "getZapierLeadFormSample": {
            "id": 1,
            "Email address": "Your \"Email address\"",
            "Full name": "Your \"Full name\"",
            "Phone number": "Your \"Phone number\"",
            "Country/region": "Your \"Country/region\"",
            "Website": "Your \"Website\"",
            "Paragraph": "Your \"Paragraph\"",
            "Custom input": "Your \"Custom input\"",
            "GDPR": "Your \"GDPR\""
        }
    }
}