Skip to content
Last updated

Edit Contact Point ==================

Overview


This section contains the required and optional elements to edit an existing contact point. .
NOTE: At least one optional element must be present with the 'id' element for the request to be successful.

Edit email contact point


Elements required in request body

NameDescription
idID of the contact point.

Optional elements allowed 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.
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.

Edit phone contact point


Elements required in request body

NameDescription
idID of the contact point.

Optional elements allowed 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.
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.

Edit postal contact point


Elements required in request body

NameDescription
idID of the contact point.

Optional elements allowed in request body

NameDescription
type.valuePostal type.
address_1Address line 1 of the postal contact point.
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.

Edit web contact point


Elements required in request body

NameDescription
idID of the contact point.

Optional elements allowed in request body

NameDescription
urlURL of the website 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.

Edit social contact point


Elements required in request body

NameDescription
idID of the contact point.

Optional elements allowed in request body

NameDescription
type.valueType of social contact point.
socialIdSocial ID of the social 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.