| Name | Description | Type | Additional information |
|---|---|---|---|
| DataSourceID |
REQUIRED - (each supplier will get its unique id) |
integer |
Required |
| BrandID |
REQUIRED - List of brands with ID’s will be supplied |
integer |
Required |
| SubscriptionStatus |
Must be set True or False (according to your system) |
boolean |
Required |
| SubscriptionDate |
REQUIRED - ISO 8601 format(YYYY-MM-DDTHH:mm:ss): Date Must be supplied – if unkown use Creation Date |
date |
Required |
| EmailAddress |
REQUIRED - Either CellNo OR EmailAddress must be supplied |
string |
None. |
| CellNo |
REQUIRED - Either CellNo OR EmailAddress must be supplied |
string |
None. |
| EmailOptIn |
REQUIRED - Must be supplied if Email was supplied |
boolean |
None. |
| MobileOptIn |
REQUIRED - Must be supplied if Cellno was supplied |
boolean |
None. |
| UnsubscribeDate |
ISO 8601 format(YYYY-MM-DDTHH:mm:ss): Must be supplied if Subscriptionstatus is 0 |
date |
None. |
| Name |
Consumer Name |
string |
None. |
| Surname |
Consumer surname |
string |
None. |
| Sex |
Sex/Gender of consumer (male, female, other, m, f, o) |
string |
None. |
| Title |
Consumer Title |
string |
None. |
| DOB |
ISO 8601 format(YYYY-MM-DDTHH:mm:ss): Cosumer date of birth |
date |
None. |
| Country |
Country of residence of consumer (Country Name or ISO 3166-1 alpha-2 Country Code ) |
string |
None. |
| StateProvince |
If Country is South Africa, this field must be one of { "Eastern Cape", "Free State", "Gauteng", "KwaZulu-Natal", "Limpopo", "Mpumalanga", "Northern Cape", "North West", "Western Cape" } |
string |
None. |
| ProvinceCode |
If Country is South Africa, this field must be one of { "EC", "FS", "GP", "KZN", "LP", "MP", "NC", "NW", "WC" } |
string |
None. |
| Organisation |
Organisation |
string |
None. |
| IDNo |
ID Number of consumer |
string |
None. |
| Age |
Age of consumer |
integer |
None. |
| Profession |
Profession of consumer |
string |
None. |
| PostalCode |
Postal code of consumer address |
string |
None. |
| RegistrationDate |
ISO 8601 format(YYYY-MM-DDTHH:mm:ss): Registration date of consumer |
date |
None. |
| AddressLine1 |
Consumer address |
string |
None. |
| AddressLine2 |
Consumer address |
string |
None. |
| AddressLine3 |
Consumer address |
string |
None. |
| City |
City |
string |
None. |
| DateTimeCreated |
ISO 8601 format(YYYY-MM-DDTHH:mm:ss): Optional creation date field which defaults to time of execution |
date |
None. |
| Campaign |
Campaign name |
string |
None. |
| MediaSource |
Represents the source from which subscription originated, such as a social media platform (e.g., Facebook, Twitter, Instagram), a search engine (e.g., Google, Bing), or other digital channels. |
string |
None. |
| Device |
Device used to subscribe, for example: Windows Desktop, IOS Mobile, Android Tablet, etc. |
string |
None. |
| AdditionalData |
Additional data can be stored in this field as a JSON object string, for example: { "user": { "id": 12345, "name": "John Doe", "email": "user@example.com" }, "settings": { "theme": "dark", "notifications": true } } |
string |
None. |