POST {clientId}/Consents/{profileId}

Consents represent a permission granted by a user for a specific purpose, such as sharing, selling, collecting, or processing of data. This method allows you to add one or more consents to a user profile.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

This is your organization’s MyPreferences account Id.

string

Required

profileId

Id of the Profile to associate consents with.

integer

Required

Body Parameters

NameDescriptionTypeAdditional information
Consents

A collection of consents associated with the profile.

Collection of CreateCustomerConsent

Request Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "Consents": [
    {
      "ConsentType": "sample string 1",
      "ConsentVersion": "sample string 2",
      "Locale": "sample string 3",
      "ConsentStatus": 1,
      "ConsentDate": "sample string 4"
    },
    {
      "ConsentType": "sample string 1",
      "ConsentVersion": "sample string 2",
      "Locale": "sample string 3",
      "ConsentStatus": 1,
      "ConsentDate": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<CreateCustomerConsentList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <Consents>
    <CreateCustomerConsent>
      <ConsentDate>sample string 4</ConsentDate>
      <ConsentStatus>Granted</ConsentStatus>
      <ConsentType>sample string 1</ConsentType>
      <ConsentVersion>sample string 2</ConsentVersion>
      <Locale>sample string 3</Locale>
    </CreateCustomerConsent>
    <CreateCustomerConsent>
      <ConsentDate>sample string 4</ConsentDate>
      <ConsentStatus>Granted</ConsentStatus>
      <ConsentType>sample string 1</ConsentType>
      <ConsentVersion>sample string 2</ConsentVersion>
      <Locale>sample string 3</Locale>
    </CreateCustomerConsent>
  </Consents>
</CreateCustomerConsentList>

Response Information

Response Codes

HTTP Status CodeTextDescription
200 OK The request was successfully processed.
400 Bad Request The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401 Unauthorized Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403 Forbidden The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
409 Conflict The request could not be completed due to a conflict with the current state of the target resource. In most cases, an instance with the same already exists on the target resource. You must update the request before trying again.
500 Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

None.