POST v1/Contacts/{contactID}/Emails

Update the Emails for a contact. This input list will replace the existing collection of Emails.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

string

Required

Body Parameters

Collection of EntityEmailDTO
NameDescriptionTypeAdditional information
EmailID

integer

None.

EntityID

integer

None.

ContactInfoTypeID

integer

None.

EmailAddress

string

None.

IsPrimary

boolean

None.

EmailOptOutLevel

integer

None.

ContactInfoName

string

None.

ContactInfoCategory

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "EmailID": 1,
    "EntityID": 2,
    "ContactInfoTypeID": 3,
    "EmailAddress": "sample string 4",
    "IsPrimary": true,
    "EmailOptOutLevel": 6,
    "ContactInfoName": "sample string 7",
    "ContactInfoCategory": "sample string 8"
  },
  {
    "EmailID": 1,
    "EntityID": 2,
    "ContactInfoTypeID": 3,
    "EmailAddress": "sample string 4",
    "IsPrimary": true,
    "EmailOptOutLevel": 6,
    "ContactInfoName": "sample string 7",
    "ContactInfoCategory": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEntityEmailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <EntityEmailDTO>
    <ContactInfoCategory>sample string 8</ContactInfoCategory>
    <ContactInfoName>sample string 7</ContactInfoName>
    <ContactInfoTypeID>3</ContactInfoTypeID>
    <EmailAddress>sample string 4</EmailAddress>
    <EmailID>1</EmailID>
    <EmailOptOutLevel>6</EmailOptOutLevel>
    <EntityID>2</EntityID>
    <IsPrimary>true</IsPrimary>
  </EntityEmailDTO>
  <EntityEmailDTO>
    <ContactInfoCategory>sample string 8</ContactInfoCategory>
    <ContactInfoName>sample string 7</ContactInfoName>
    <ContactInfoTypeID>3</ContactInfoTypeID>
    <EmailAddress>sample string 4</EmailAddress>
    <EmailID>1</EmailID>
    <EmailOptOutLevel>6</EmailOptOutLevel>
    <EntityID>2</EntityID>
    <IsPrimary>true</IsPrimary>
  </EntityEmailDTO>
</ArrayOfEntityEmailDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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>