POST v1/Contacts/{contactID}/PhoneNumbers

Update the phone numbers for a contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

Id of the contact

string

Required

Body Parameters

List of new phone numbers

Collection of PhoneNumberDTO
NameDescriptionTypeAdditional information
PhoneNumberID

integer

None.

EntityID

integer

None.

ContactInfoTypeID

integer

None.

PhoneNumber

string

None.

IsPrimary

boolean

None.

IsTextActive

boolean

None.

ContactInfoName

string

None.

ContactInfoCategory

string

None.

Notes

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "PhoneNumberID": 1,
    "EntityID": 2,
    "ContactInfoTypeID": 3,
    "PhoneNumber": "sample string 4",
    "IsPrimary": true,
    "IsTextActive": true,
    "ContactInfoName": "sample string 7",
    "ContactInfoCategory": "sample string 8",
    "Notes": "sample string 9"
  },
  {
    "PhoneNumberID": 1,
    "EntityID": 2,
    "ContactInfoTypeID": 3,
    "PhoneNumber": "sample string 4",
    "IsPrimary": true,
    "IsTextActive": true,
    "ContactInfoName": "sample string 7",
    "ContactInfoCategory": "sample string 8",
    "Notes": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPhoneNumberDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <PhoneNumberDTO>
    <ContactInfoCategory>sample string 8</ContactInfoCategory>
    <ContactInfoName>sample string 7</ContactInfoName>
    <ContactInfoTypeID>3</ContactInfoTypeID>
    <EntityID>2</EntityID>
    <IsPrimary>true</IsPrimary>
    <IsTextActive>true</IsTextActive>
    <Notes>sample string 9</Notes>
    <PhoneNumber>sample string 4</PhoneNumber>
    <PhoneNumberID>1</PhoneNumberID>
  </PhoneNumberDTO>
  <PhoneNumberDTO>
    <ContactInfoCategory>sample string 8</ContactInfoCategory>
    <ContactInfoName>sample string 7</ContactInfoName>
    <ContactInfoTypeID>3</ContactInfoTypeID>
    <EntityID>2</EntityID>
    <IsPrimary>true</IsPrimary>
    <IsTextActive>true</IsTextActive>
    <Notes>sample string 9</Notes>
    <PhoneNumber>sample string 4</PhoneNumber>
    <PhoneNumberID>1</PhoneNumberID>
  </PhoneNumberDTO>
</ArrayOfPhoneNumberDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

Action result

ActionResultDTO
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "InfoMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<ActionResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <InfoMessage>sample string 4</InfoMessage>
  <IsSuccess>true</IsSuccess>
</ActionResultDTO>