Skip to content
Last updated

Create Contact Point ====================

Overview


This section contains the required and optional elements for contact point. Multiple contact points can be created for a contact person.

Create email contact point


Elements required in request body

NameDescription
emailAddressMust be a valid email address. Refer Email Address definition for the valid email address format.
If "Customer departmentalization" setting is enabled in the application, the provided email address must not be associated with any existing contact points in the same department.
If "Customer departmentalization" setting is disabled in application, the provided email address must not be associated with any existing contact points in the application.

Optional elements allowed in request body

NameDescription
priority.valuePriority of the contact point
customAttributesName and value of all the custom attributes configured for the Contact Point 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.

Create phone contact point


Elements required in request body

NameDescription
type.valuePhone type.
phoneNoPhone number. This accepts any string representation. It is the client's responsibility to send in the correct number.

Optional elements allowed in request body

NameDescription
countryCodeCountry code.
areaCodeArea code.
extensionExtension.
availability.days.valueDays when available.
availability.times.valueTime of day when available.
priority.valuePriority of the contact point
phone.customAttributesName and value of all the custom attributes configured for the Contact Point 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.

Create postal contact point


Elements required in request body

NameDescription
type.valuePostal type.
address_1Address line 1 of the postal contact point.

Optional elements allowed in request body

NameDescription
address_2Address line 2 of the postal contact point.
cityCity of the postal contact point.
stateState of the postal contact point.
zipZip code of the postal contact point.
countryCountry of the postal contact point.
regionRegion of the postal contact point.
priority.valuePriority of the contact point
customAttributesName and value of all the custom attributes configured for the Contact Point 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.

Create web contact point


Elements required in request body

NameDescription
urlURL of the website contact point.

Optional elements allowed in request body

NameDescription
priority.valuePriority of the contact point
customAttributesName and value of all the custom attributes configured for the Contact Point 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.

Create social contact point


Elements required in request body

NameDescription
type.valueType of social contact point.
socialIdSocial ID of the social contact point.

Optional elements allowed in request body

NameDescription
priorityPriority of the contact point
customAttributesName and value of all the custom attributes configured for the Contact Point 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.