Reference for the Template Resource

Example JSON

{
    "name": "People Template",
    "columns": [
      {
        "label": "First Name",
        "key": "first_name",
        "data_type": "FIRST_NAME",
        "is_required": true,
        "is_unique": true
      },
      {
        "label": "Last Name",
        "key": "last_name",
        "data_type": "LAST_NAME",
        "is_required": true
      },
      {
        "label": "Email",
        "key": "email",
        "data_type": "EMAIL",
        "is_required": true
      },
      {
        "label": "EIN / ITIN",
        "key": "ein_itin",
        "data_type": "CUSTOM_REGEX",
        "validation_options": {
            "regex": "(^\d{2}[-]\d{7}$)|(^9\d{2}[-]\d{2}[-]\d{4}$)"
        }
      },
      {
        "label": "FICO Score",
        "key": "fico_score",
        "data_type": "NUMBER",
        "validation_options": {
          "min_num": 350,
          "max_num": 800
        }
      },
      {
        "label": "Status",
        "key": "status",
        "data_type": "PICKLIST",
        "validation_options": {
          "values": [
            "NEW",
            "APPROACHING",
            "QUALIFIED",
            "CLOSED WON",
            "CLOSED LOST"
          ]
        },
        "letter_case": "LETTER_CASE_UPPER"
      },
      {
        "label": "Date",
        "key": "date",
        "data_type": "DATE_ISO"
        "is_custom": true,
      },
      {
        "label": "Phone Number",
        "key": "phone_number",
        "data_type": "US_PHONE_NUMBER_EXT"
      },
      {
        "label": "Last Meeting",
        "key": "last_meeting",
        "data_type": "DATE_MDY"
      },
      {
        "label": "Description",
        "key": "description",
        "data_type": "TEXT",
        "max_char_limit": 300
      }
    ],
    "template_key": "template_people",
    "validation_hooks": [
      {
        "name": "Hook 1",
        "url": "https://acme.co/api/validation/check-email",
        "secret_key": "4GPyQabv7Kbv0ZLQXRBvGnSRSRCzdVVz",
        "column_keys": [
          "first_name",
          "last_name",
          "email",
        ]
      }
    ],
  ],
}

Validation Types

Validation types will indicate the type of validation that failed (e.g., a MM/DD/YY date validation, or and email address validation). Here is a list of all available validations.

[
    PICKLIST,
    NUMBER,
    PERCENTAGE,
    DATE_MDY,
    DATE_DMY,
    DATE_ISO,
    DATETIME_ISO,
    DATETIME_MDYHM,
    DATE_YMD,
    DATE_DMMMY,
    TIME_HHMM,
    UNIX_TIMESTAMP,
    LOCATION_ADDRESS,
    URL,
    DOMAIN,
    FULL_NAME,
    FIRST_NAME,
    LAST_NAME,
    EMAIL,
    UNIT_OF_MEASURE,
    CURRENCY_CODE,
    PHONE_NUMBER,
    US_PHONE_NUMBER_EXT,
    MONEY,
    COUNTRY_CODE_A2,
    COUNTRY_CODE_A3,
    IANA_TIMEZONE,
    CUSTOM_REGEX,
    ALPHABETICAL,
    TEXT,
    CAS_NUMBER,
    SSN_MASKED,
    SSN_UNMASKED,
]