PUT api/v2/Users/{id}/UserContactItem
Upserts a Contact Information to an existing User. Returns Success/Error along with the PK of the Contact Info The PK of the existing User that you want to upsert the Contact Item fromRequired: The Contact Info Item you want to upsert
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
UpsertContactItemViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Required: The PK of the existing User that you want to add or update the Contact Item to. |
globally unique identifier |
None. |
| ContactSubType |
Required: The type of contact information being added or updated - Retrieve possible values from /ContactItem/GetAllTypes |
globally unique identifier |
None. |
| Value |
Required: Represents the Contact Item value - an email address, a phone number |
string |
None. |
| IsDefault |
Required: Specifies if the Contact Item is the default method of contact for that Contact Type (default email, default phone, etc.) |
boolean |
None. |
Request Formats
application/json, text/json
{
"UserId": "ba6cebf4-2d40-4f4f-8dc4-db9c8654bd85",
"ContactSubType": "74da0d84-7a69-40ce-ab3d-b2c67450d7c9",
"Value": "sample string 3",
"IsDefault": true
}
application/xml, text/xml
<UpsertContactItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <ContactSubType>74da0d84-7a69-40ce-ab3d-b2c67450d7c9</ContactSubType> <IsDefault>true</IsDefault> <UserId>ba6cebf4-2d40-4f4f-8dc4-db9c8654bd85</UserId> <Value>sample string 3</Value> </UpsertContactItemViewModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ResultWithGuid| Name | Description | Type | Additional information |
|---|---|---|---|
| Value |
Represents the PK value that was created as a result of an add |
globally unique identifier |
None. |
| ResultCode |
Represents the result code |
integer |
None. |
| Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
{
"Value": "bf93ce28-cdb6-4715-b38f-fcfb8f08bd66",
"ResultCode": 2,
"Description": "sample string 3"
}
application/xml, text/xml
<ResultWithGuid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 3</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>2</ResultCode> <Value>bf93ce28-cdb6-4715-b38f-fcfb8f08bd66</Value> </ResultWithGuid>