Create Footprint

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 IDInput TypeRequired Parameters
tpl-ftp005001Email addressconsent, templateId, emailAddress
tpl-ftp005002Mobile numberconsent, templateId, mobileNumber

Field Rules

  • For tpl-ftp005001, emailAddress must be provided and mobileNumber must be omitted.
  • For tpl-ftp005002, mobileNumber must be provided and emailAddress must be omitted.
  • emailAddress and mobileNumber cannot be used together in the same request.

Sandbox Test Values

Template IDTest InputExpected Response
tpl-ftp005001emailAddress = [email protected]resultCode = SUCCESS
tpl-ftp005002mobileNumber = 639559991234resultCode = 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.

Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!