Set the formal salutation for a contact
The API provides feature to set the formal salutation for a contact, the API can be used for both setting and updating the formal salutation for a contact, in order to set a formal salutation pass the valid salutation id along with the contact Id.
Request Information
Body Parameters
Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.
Salutation Information
Name | Description | Type | Additional information |
---|---|---|---|
Id |
Contact Id |
integer |
None. |
Salutation |
Salutation |
Salutation |
None. |
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
{ "Id": 1, "Salutation": { "Id": "String Parameter 1", "Value": "String Parameter 2" } }
Setting a formal salutation
Below is the sample shows how to set the formal salutation for a contact.
{ "Id": 9831292, "Salutation": { "Id": "F", "Value": "Banshi" } }
Response Information
Resource Description
True if Salutation was set, false otherwise
ITypedResponseOfNullableOfBooleanName | Description | Type | Additional information |
---|---|---|---|
Result | boolean |
None. |
|
Category | string |
None. |
Response Formats
Sample not available.