Edit Contact Point
Overview
This section contains the required and optional elements to edit an existing contact point.
Email contact point
Elements required in request body
| Name | Description |
| id | ID of the contact point. |
Optional elements allowed in request body
| Name | Description |
| type.email.emailAddress | Must 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.value | Must be 'low', 'medium', or 'high'. |
| customAttributes | 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. |
Phone contact point
Elements required in request body
| Name | Description |
| id | ID of the contact point. |
Optional elements allowed in request body
| Name | Description |
| type.phone.type.value | This can be one of 'home', 'office', 'mobile', 'fax', or 'pager'. |
| type.phone.phoneNo | This accepts any string representation. It is the client's responsibility to send in the correct number. Must not exceed 40 characters. |
| type.phone.countryCode | Must be a number not exceeding 9 digits. |
| type.phone.areaCode | Must not exceed 10 characters. |
| type.phone.extension | Must not exceed 10 characters. |
| type.phone.availability.days.value | Must be one of weekdays, weekends, and 'any_day'. |
| type.phone.availability.times.value | Must be one of 'mornings', 'afternoons', 'evenings', 'day', and 'anytime'. |
| priority.value | Must be 'low', 'medium', or 'high'. |
| customAttributes | 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. |
Postal contact point
Elements required in request body
| Name | Description |
| id | ID of the contact point. |
Optional elements allowed in request body
| Name | Description |
| type.postal.type.value | Must be one of 'office', 'home', 'mailto', 'billto', or 'shipto'. |
| type.postal.address_1 | Must not exceed 50 characters. |
| type.postal.address_2 | Must not exceed 50 characters. |
| type.postal.city | Must not exceed 50 characters. |
| type.postal.state | Must not exceed 50 characters. |
| type.postal.zip | Must not exceed 50 characters. |
| type.postal.country | Must not exceed 50 characters. |
| type.postal.region | Must not exceed 50 characters. |
| priority.value | Must be 'low', 'medium', or 'high'. |
| customAttributes | 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. |
Web contact point
Elements required in request body
| Name | Description |
| id | ID of the contact point. |
Optional elements allowed in request body
| Name | Description |
| type.website.url | Must not exceed 1024 characters. |
| priority.value | Must be 'low', 'medium', or 'high'. |
| customAttributes | 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. |
Social contact point
Elements required in request body
| Name | Description |
| id | ID of the contact point. |
Optional elements allowed in request body
| Name | Description |
| type.social.type.value | Must be one of 'twitter, 'facebook', 'instagram', 'apple_opaque_id', 'community', or 'other'.
Note: The type of an existing social ID cannot be changed. |
| type.socialId | Must not exceed 255 characters. |
| priority.value | Must be 'low', 'medium', or 'high'. |
| customAttributes | 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. |
