Skip to content
Last updated

Create Contact ==============

Overview


This section contains the required and optional elements for contact. A single contact can be created for an individual customer and multiple contacts can be created for group and corporate customers. One contact can contain multiple contact points.

Elements required in request body

NameDescription
firstNameFirst name of the contact.

Optional elements allowed in request body

NameDescription
salutationSalutation of the contact.
middleNameMiddle name of the contact.
lastNameLast name of the contact.
loginIdLogin ID of the contact.
gender.valueGender of the contact.
identification.typeIdentification type of the contact. Must be one of the values configured in application.
identification.valueIdentification value of the contact.
suffix.valueSuffix to use for the contact.
initialsInitials of the contact.
secretQuestionSecret question which should be asked to the contact if he forgets his password.
secretAnswerSecret answer to secret question asked to the contact if he forgets his password.
hasDirectMailingConsentField to convey if direct mailing consent is given by the contact.
hasDirectCallingConsentField to convey if direct calling consent is given by the contact.
hasHoldingDataConsentField to convey if holding data consent is given by the contact.
jobTitleJob Title of the contact.
employmentStatus.valueEmployment status of the contact.
priorityPriority of the contact.
dateOfBirthDate of birth of the contact.
maritalStatus.valueMarital status of the contact.
type.valueContact's type (e.g. billing, legal, shipping etc.). Must be one of the values configured in application.
firstNameFuriganaString to specify how the first name of the contact should be pronounced.
middleNameFuriganaString to specify how the middle name of the contact should be pronounced.
lastNameFuriganaString to specify how the last name of the contact should be pronounced.
startGreetingString to specify start greeting to use for the contact.
endGreetingString to specify end greeting to use for the contact.
spouseNameName of spouse of the contact.
emergencyContactEmergency Contact information of the contact.
occupationOccupation of the contact.
incomeLevelIncome level of the contact.
educationLevel.valueEducation level of the contact.
raceRace of the contact.
dependentsDependents of the contact.
smokerField to convey if the contact is a smoker.
hobbiesHobbies of the contact.
interestsInterests of the contact.
contactOrderNumber specifying the order in which this contact should be contacted if there are more than one contacts for the same customer.
emailEmail contact points. Contact can have multiple email contact points. For required and optional elements of email contact point, refer here.
postalPostal contact points. Contact can have multiple postal contact points. For required and optional elements of postal contact point, refer here.
phonePhone contact points. Contact can have multiple phone contact points. For required and optional elements of phone contact point, refer here.
socialSocial contact points. Contact can have multiple social Contact points. For required and optional elements of social contact point, refer here.
webWeb contact points. Contact can have multiple web Contact points. For required and optional elements of web contact point, refer here.
customAttributesName and value of all the custom attributes configured for the Contact Object.Name must match one of the custom attributes configured in application. If the custom attribute is configured as an enumeration, the value must be one of the predefined values.
For string type of custom attribute that is not configured as an enumeration, refer list of Allowed Characters For Custom Attributes.