Create Footprint

post

https://sandbox.smileapi.io/v1/alpha/footprints

Create a Footprint object.

This endpoint requires the following mandatory parameters:

Additional required fields depend on the selected templateId.

Template ID	Input Type	Required Parameters
`tpl-email-footprint`	Email address only	`consent`, `templateId`, `emailAddress`, `countryCode`
`tpl-mobile-footprint`	Mobile number only	`consent`, `templateId`, `mobileNumber`, `countryCode`
`tpl-score-footprint`	Email + mobile number	`consent`, `templateId`, `emailAddress`, `mobileNumber`, `countryCode`
`tpl-ftp005001` (deprecated)	Email address only	`consent`, `templateId`, `emailAddress`, `countryCode`
`tpl-ftp005002` (deprecated)	Mobile number only	`consent`, `templateId`, `mobileNumber`, `countryCode`

For tpl-ftp005001, emailAddress must be provided and mobileNumber should be omitted or null.
For tpl-ftp005002, mobileNumber must be provided and emailAddress should be omitted or null.
For tpl-score-footprint, emailAddress and mobileNumber must both be provided.
For all templates, countryCode is required and must be a valid ISO country code.

Template ID	Test Input	Expected Response
`tpl-email-footprint`	`emailAddress = [email protected]`, `countryCode = PH`	`resultCode = SUCCESS`
`tpl-mobile-footprint`	`mobileNumber = 639559991234`, `countryCode = PH`	`resultCode = SUCCESS`
`tpl-score-footprint`	`emailAddress = [email protected]`, `mobileNumber = 639559991234`, `countryCode = PH`	`resultCode = SUCCESS`

For all other valid input combinations, if no mock data is matched, the response will return:
resultCode = NO_DATA, and no items will be included.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

emailAddress

string

required

The email address of the subject. It must be a valid email address. Required for tpl-ftp005001.

countryCode

string | null

enum

2 character alpha ISO-3166 codes

templateId

string

required

Fixed to tpl-email-footprint (or legacy tpl-ftp005001, deprecated).

footprintItemsTimeout

integer

1 to 30

Timeout in seconds for footprint items. If exceeded, returns completed footprint items, others items' values will be null.

consent

object

required

Response