PUT api/v2/clientcontact/{clientcontactid}/updateoptout

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientcontactid

integer

Required

Body Parameters

OptOutOptions
NameDescriptionTypeAdditional information
RefID

integer

None.

RefType

integer

None.

NameEnabled

boolean

None.

MailingAddressEnabled

boolean

None.

UnitAddressEnabled

boolean

None.

EmailEnabled

boolean

None.

PhotoEnabled

boolean

None.

PhoneEnabled

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "RefID": 1,
  "RefType": 2,
  "NameEnabled": true,
  "MailingAddressEnabled": true,
  "UnitAddressEnabled": true,
  "EmailEnabled": true,
  "PhotoEnabled": true,
  "PhoneEnabled": true
}

application/xml, text/xml

Sample:
<OptOutOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <EmailEnabled>true</EmailEnabled>
  <MailingAddressEnabled>true</MailingAddressEnabled>
  <NameEnabled>true</NameEnabled>
  <PhoneEnabled>true</PhoneEnabled>
  <PhotoEnabled>true</PhotoEnabled>
  <RefID>1</RefID>
  <RefType>2</RefType>
  <UnitAddressEnabled>true</UnitAddressEnabled>
</OptOutOptions>

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.