Bunker DB's Consumer API fixed fields allow you to capture basic consumer data in any integration.
In the response of the API call, fixed fields are identified as "false" in the "dynamicField" field, thus differentiating them from custom fields.
The request body is an object with the following properties:
The body of the request is an object with the following properties:
*platform_id: (string [3-254]). Platform identifier: ‘facebook_app’, ‘web’, ‘google’.
external_id: (string [1-45]) Object external identifier. If it was used in a previous request to add an
ActionPersonData object whose campaign_id property had the same value, the previous object will be removed to avoid two objects in the same campaign with the same external identifier.
obtained_time: (datetime) Date and time when the data of this person were obtained.
Format must be defined in ISO 8601.
The default value is the date and time when the server receives the request.facebook_uid: (string [1 -50]) Facebook identifier.
email: (string [3 -254]) email.
twitter_uid: (string [1 -50]) Twitter identifier.
linkedin_uid: (string [1-50]) LinkedIn identifier.
google_uid: (string [1 -50]) Google identifier.
cellphone: (string [4 -50]) mobile phone number.
document: (string [5 -20]) Document number.
document_type: (string) Document type. By default ‘DNI’ will be assigned. It must be one of the following values:
Citizen: Credencial.
DFI: Documento de identificación Federal.
DNI: Documento de identificación Nacional.
Driver: Driver’s license.
Militar: Military ID.
Passport: Passport.
Social: Social security number (SSN).
CPF: Cadastro de Pessoas Físicas.
document_country: (string [2]) Document issuing country. Format must be defined in ISO 3166-1 in a two-letter format. The list is shown in ISO 3166-1-alpha-2 format. Default assign will be: ‘UY’.
phone: (string [4-50]) Phone number.
first_name: (string [1-100]) Name.
last_name: (string [1-100]) Last name.
gender: (char [1]) Gender.
‘f’ = female.
‘m’ = male.
birthday: (date) Date of birth. Date format must be YYYY-MM-DD. Example: 1983-02-26.
Maximum range is 130 years.address_country: (string [2]) Residence country. Format must be defined in ISO 3166-1 in a two-letter format.
address: (string [1-65535]) Physical address. You can use address_line_one and address_line_two instead. Keep in mind that "address" will have priority.
address_line_one: (string [1-65535]) Address first line, note that if you use address, this field will have priority.
address_line_two: (string [1-65535]) Address second line, note that if you use address, this field will have priority.
address_postal_code: (string [1-50]) Zip code number.
address_state: (string [1-255]) State/department name.
address_city: (string [1-255]) City name.
allow_newsletters: (Booleano) Defines if a consumer agrees to receive the newsletter.
allow_sms: (booleano) Defines if a consumer agrees to receive SMS.
allow_brand: (booleano) Defines if a consumer agrees to receive brand’s content.
allow_global: (booleano) Defines if a consumer agrees to receive other brand’s content from the same company.
device: (string [15]) Device type.
‘desktop’
‘tablet’
‘phone’
preferences: Consumer assigned preferences in json format.
These preferences must be equal to the campaign’s preferences.