Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Request Queues

Create Request

❗️ End of Support Notification

As of March 3, 2022, this API is now deprecated. Any customers leveraging this API are encouraged to migrate to the Create Request API. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.

Use this API to create a request for a given hosted web form. The webform must already be created.

post/api/datasubject/v2/requestqueues

Request body

templateIdstring uuid
firstNamestring

First name of the respondent.

lastNamestring

Last name of the respondent.

emailstring

Email address of the respondent.

languagestring

The ISO language code for OneTrust supported languages. Examples: en-us for English, de for German, fr for French, etc.

additionalDataobject

Additional fields in key value format, required for request processing. These could be webform or non webform fields

requestTypesobject[]

Respondents privacy request type. This should match with the webform subject type key, key values are part for webform submission payload.

subjectTypesobject[]

Respondents subject type or relation ship with tenant. This should match with the webform subject type key, key values are part for webform submission payload.

requestTraceIdstring uuid

Unique trace id for request. This can be used to avoid creating duplicate request.

multiselectFieldsobject

Example request

{
  "firstName": "Test",
  "lastName": "User",
  "email": "testuser@onetrust.com",
  "language": "en-us",
  "additionalData": {
    "key": "value"
  },
  "requestTraceId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
}

Response

OK