POST v1/Contacts/{contactID}/Emails

Update the Emails for a contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

Id of the contact

string

Required

Body Parameters

New list of Emails

Collection of EntityEmailDTO
NameDescriptionTypeAdditional information
EmailID

Id of the email

integer

None.

EntityID

Id of the entity

integer

None.

ContactInfoTypeID

Id of the contact info type

integer

None.

EmailAddress

Email address

string

None.

IsPrimary

Signifies whether the email is primary

boolean

None.

EmailOptOutLevel

Email opt out level

integer

None.

ContactInfoName

Contact info name

string

None.

ContactInfoCategory

Contact info category

string

None.

Notes

Notes

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",
    "Notes": "sample string 9"
  },
  {
    "EmailID": 1,
    "EntityID": 2,
    "ContactInfoTypeID": 3,
    "EmailAddress": "sample string 4",
    "IsPrimary": true,
    "EmailOptOutLevel": 6,
    "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:
<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>
    <Notes>sample string 9</Notes>
  </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>
    <Notes>sample string 9</Notes>
  </EntityEmailDTO>
</ArrayOfEntityEmailDTO>

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>