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

Id of the phone number

integer

None.

EntityID

Id of the entity

integer

None.

ContactInfoTypeID

Id of the contact info type

integer

None.

PhoneNumber

Phone number

string

None.

IsPrimary

Signifies whether the phone number is primary

boolean

None.

IsTextActive

Signifies whether the text is active

boolean

None.

ContactInfoName

Name of the contact info

string

None.

ContactInfoCategory

Category of the contact info

string

None.

Notes

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/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'.

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>

Response Information

Resource Description

Action result

ActionResultDTO
NameDescriptionTypeAdditional information
IsSuccess

Signifies whether action is successful

boolean

None.

ErrorCode

Error code

string

None.

ErrorMessage

Error message

string

None.

InfoMessage

Information message

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>