PUT api/clients/{clientId}/contact
Updates an existing client contact.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Id of the client. |
integer |
Required |
Body Parameters
The contact to update.
Contact| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Gets or sets the ID that represents this contact. |
integer |
None. |
| ReferenceId |
Gets or sets a reference ID to help us accurately determine whether this contact's entry is the same as another contact in a different address from the same Get Client request. If you modify the details of one instance of a contact, you should update all of them because there's no guarantee about which instancewill be saved. There is no guarantee that this ID will match between different calls. |
string |
None. |
| ContactType |
Gets or sets a string that describes the type of contact this is. |
string |
None. |
| FirstName |
Gets or sets the first name of the person that this contact information belongs to. |
string |
None. |
| LastName |
Gets or sets the last name of the person that this contact information belongs to. |
string |
None. |
| Comments |
The comments on the contact, if any |
string |
None. |
| Details |
Gets or sets the details of how to contact this person. |
Collection of ContactDetail |
None. |
Request Formats
application/json, text/json
{
"id": 1,
"referenceId": "sample string 2",
"contactType": "sample string 3",
"firstName": "sample string 4",
"lastName": "sample string 5",
"comments": "sample string 6",
"details": [
{
"id": 1,
"contactString": "sample string 2",
"type": {
"code": "sample string 1",
"name": "sample string 2",
"type": 0
},
"isPreferred": true
},
{
"id": 1,
"contactString": "sample string 2",
"type": {
"code": "sample string 1",
"name": "sample string 2",
"type": 0
},
"isPreferred": true
}
]
}
application/xml, text/xml
<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
<Comments>sample string 6</Comments>
<ContactType>sample string 3</ContactType>
<Details>
<ContactDetail>
<ContactString>sample string 2</ContactString>
<ID>1</ID>
<IsPreferred>true</IsPreferred>
<Type>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Type>Phone</Type>
</Type>
</ContactDetail>
<ContactDetail>
<ContactString>sample string 2</ContactString>
<ID>1</ID>
<IsPreferred>true</IsPreferred>
<Type>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Type>Phone</Type>
</Type>
</ContactDetail>
</Details>
<FirstName>sample string 4</FirstName>
<ID>1</ID>
<LastName>sample string 5</LastName>
<ReferenceId>sample string 2</ReferenceId>
</Contact>
application/x-www-form-urlencoded
Sample not available.
Response Information
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.