POST api/people/{id}/addcontactitem
Add a ContactItem to a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
Body Parameters
The contact item save command data contract supplied with the request.
ContactItemSaveCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The unique identifier of this resource. |
integer |
None. |
| Type |
The type value. |
EnumDataContract |
None. |
| Value |
The value represented by this field. |
string |
None. |
| Notes |
The notes value. |
string |
None. |
| ContactOrder |
The contact order value. |
integer |
None. |
| AllowContact |
Indicates whether allow contact is true. |
boolean |
None. |
| MarketingContactStatus |
The marketing contact status value. |
EnumDataContract |
None. |
| NormalisedRegionCode |
The normalised region code value. |
string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"Id": 1,
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 2",
"Notes": "sample string 3",
"ContactOrder": 4,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"NormalisedRegionCode": "sample string 5"
}
Response Information
Resource Description
The created ContactItem
ContactItemDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Type |
The type value. |
EnumDataContract |
None. |
| Value |
The value represented by this field. |
string |
None. |
| Notes |
The notes value. |
string |
None. |
| ContactOrder |
The contact order value. |
integer |
None. |
| AllowContact |
Indicates whether allow contact is true. |
boolean |
None. |
| MarketingContactStatus |
The marketing contact status value. |
EnumDataContract |
None. |
| Name |
The name value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
}