Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Footprints (Alpha)

Create Footprint

Create a Footprint object.

This endpoint requires the following mandatory parameters:

  • consent
  • templateId

Additional required fields depend on the selected templateId.

Supported Templates

Template IDInput TypeRequired Parameters
tpl-email-footprintEmail address onlyconsent, templateId, emailAddress, countryCode
tpl-mobile-footprintMobile number onlyconsent, templateId, mobileNumber, countryCode
tpl-score-footprintEmail + mobile numberconsent, templateId, emailAddress, mobileNumber, countryCode
tpl-ftp005001 (deprecated)Email address onlyconsent, templateId, emailAddress, countryCode
tpl-ftp005002 (deprecated)Mobile number onlyconsent, templateId, mobileNumber, countryCode

Field Rules

  • 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.

Sandbox Test Values

Template IDTest InputExpected Response
tpl-email-footprintemailAddress = gpalomero1234@smileapi.io, countryCode = PHresultCode = SUCCESS
tpl-mobile-footprintmobileNumber = 639559991234, countryCode = PHresultCode = SUCCESS
tpl-score-footprintemailAddress = gpalomero1234@smileapi.io, mobileNumber = 639559991234, countryCode = PHresultCode = 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.

post/alpha/footprints

Request body

OR
OR
OR
OR
OR

Example request

{
  "emailAddress": "gpalomero1234@smileapi.io",
  "countryCode": "PH",
  "templateId": "tpl-email-footprint",
  "footprintItemsTimeout": 5,
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "createdAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "emailAddress": "gpalomero1234@smileapi.io",
      "countryCode": "PH",
      "templateId": "tpl-email-footprint",
      "footprintItemsTimeout": 5,
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    }
  }
}