POST v1/OptedIn?clientID={clientID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

string

Required

Body Parameters

OptedInReqObj
NameDescriptionTypeAdditional information
Status

boolean

None.

AcctId

globally unique identifier

None.

AuthKey

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "Status": true,
  "AcctId": "97a8b4d8-a573-4bee-bb1a-be7c2f9ee8b4",
  "AuthKey": "3edff540-2302-4d8c-b767-769daa62a2cc"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OptedInResponseObj
NameDescriptionTypeAdditional information
theValue

boolean

None.

error

string

None.

exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "theValue": true,
  "error": "sample string 2",
  "exception": "sample string 3"
}