Demographic Fields
Introduction
Demographic fields are standard to all campaigns in Hawk Redeem and therefore are not returned by the Campaign Service. These attributes must be sent when creating a submission.
Name | Description | Type | Required |
---|---|---|---|
firstName | First name. - Max. Length: 35 - Regex: ^[a-zA-Z ]{0,35}$ | String | Conditional. If company name is not provided then this field is required. |
lastName | Last name. - Max. Length: 35 - Regex: ^[a-zA-Z ]{0,35}$ | String | Conditional. If company name is not provided then this field is required. |
companyName | Company name - Max. Length: 50 - Regex: ^[a-zA-Z0-9 &']{0,50}$ | String | Conditional. If first and last name are not provided then company name is required. |
address1 | First line of the address. - Max. Length: 64 - Regex: ^[0-9a-zA-Z \#.,\-'\/]{0,64}$ | String | Yes |
address2 | Second line of the address. - Max. Length: 64 - Regex: ^[0-9a-zA-Z \#.,\-'\/]{0,64}$ | String | No |
city | City of the address. - Max. Length: 50 - Regex: ^[a-zA-Z ]{0,50}$ | String | Yes |
stateCode | Two digit state code for the address. Example: TX. - Max. Length: 5 - Regex: ^[a-zA-Z]{2,5}$ | String | Yes |
countryCode | Two digit ISO-3166 country code for the address. Only US and CA are allowed through this API.- Max. Length: 2 - Regex: ^US|CA$ | String | Yes |
postalCode | ZIP Code or Postal Code of the address. Example: 75067 or A1A 1A1 - Max. Length: 5 digits or 7 characters - Regex: ^\d{5}$|^[ABCEGHJKLMNPRSTVXY]{1}\d{1}[A-Z]{1} *\d{1}[A-Z]{1}\d{1}$ | String | Yes |
zipPlus4Code | ZIP Code +4 value for the address (US only). - Max. Length: 4 - Regex: ^\d{4,4}$ | String | No |
Email address. - Max. Length: 50 - Regex: ^[A-Za-z0-9._%-]+@[A-Za-z0-9.-]+\.[a-zA-Z]{2,4}$ | String | No | |
telephoneNumber | Telephone number. - Max. Length: 10 - Regex: ^[0-9]{0,10}$ | String | No |
Updated about 5 years ago