Sign in
Footprints (Alpha)

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 = gpalomero1234@smileapi.ioresultCode = 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.

post/alpha/footprints

Request body

emailAddressstring

The email address of the subject. It must be a valid email address.

mobileNumberstring

Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros

templateIdstring required

Generated internally by Smile. Customers should request the specific templateId from Smile.

Example request

{
  "emailAddress": "some@email.com",
  "mobileNumber": "639178902345",
  "templateId": "footprintTpl-xxxxxxxxxxxxxxx",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions",
    "consentTemplateId": "ct-4604588d9502491b4c72a67cdb0a2aea"
  }
}

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": "some@email.com",
      "mobileNumber": "639178902345",
      "templateId": "footprintTpl-xxxxxxxxxxxxxxx",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions",
        "consentTemplateId": "ct-4604588d9502491b4c72a67cdb0a2aea"
      }
    }
  }
}

Changes