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.

Body Params
uuid
string

First name of the respondent.

string

Last name of the respondent.

string

Email address of the respondent.

string
length ≥ 1

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

additionalData
object

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

requestTypes
array of objects

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

requestTypes
subjectTypes
array of objects

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.

subjectTypes
attachments
array of objects
attachments
attachmentResponses
array of objects
attachmentResponses
uuid

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

multiselectFields
object
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response
Choose an example:
*/*