post https://sandbox.smileapi.io/v1/alpha/footprints
Create a Footprint object.
This endpoint requires the following mandatory parameters:
consent
templateId
In addition, you must provide either emailAddress
or mobileNumber
— these two are mutually exclusive.
Supported Templates
Template ID | Input Type | Required Parameters |
---|---|---|
tpl-ftp005001 | Email address | consent , templateId , emailAddress |
tpl-ftp005002 | Mobile number | consent , templateId , mobileNumber |
Field Rules
- For
tpl-ftp005001
,emailAddress
must be provided andmobileNumber
must be omitted. - For
tpl-ftp005002
,mobileNumber
must be provided andemailAddress
must be omitted. emailAddress
andmobileNumber
cannot be used together in the same request.
Sandbox Test Values
Template ID | Test Input | Expected Response |
---|---|---|
tpl-ftp005001 | emailAddress = [email protected] | resultCode = SUCCESS |
tpl-ftp005002 | mobileNumber = 639559991234 | 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.