---
title: "Create Request"
method: POST
path: "/api/datasubject/v2/requestqueues/{templateId}"
tags: ["Request Queues"]
---

# Create Request

`POST /api/datasubject/v2/requestqueues/{templateId}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/datasubject/v2/requestqueues/{templateId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `DSAR`, `DSAR_WRITE`

Use this API to create a new request for the specified web form.

> 🗒 Things to Know
>
> - Visibility rules configured for the web form associated to the specified template will not be inherited after request creation. For more information, see [Configuring Dynamic Fields with Visibility Rules](https://my.onetrust.com/s/article/UUID-65f49274-b310-d0ef-397c-1d186871d920).

## Path parameters

- `templateId` string, uuid, required: Every request is created against a webform template. The template ID is the GUID corresponding to a particular webform. This can be obtained from the url by navigating to the webform. e.g. in this url, 'https://trial.onetrust.com/app/#/pia/dsar/webform/manage/6519ffd5-fe6b-4804-8dfc-1c2ae2da212d', '6519ffd5-fe6b-4804-8dfc-1c2ae2da212d' is the templateId.

## Request body

- PrivacyAutomationDataSubjectRequestDSRAutomationCreateRequestQueue
  - `firstName` string: First name of the respondent.
  - `lastName` string: Last name of the respondent.
  - `email` string: Email address of the respondent.
  - `language` string: 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` string[]: Respondents privacy request type. This should match with the webform request type.
  - `subjectTypes` string[]: Respondents subject type or relation ship with tenant. This should match with the webform subject type.
  - `multiselectFields` object
  - `requestTraceId` string, uuid: Unique trace id for request. This can be used to avoid creating duplicate request.
  - `attachments` PrivacyAutomationDataSubjectRequestDSRAutomationAttachmentV2Dto[]: File attachment details for request.
    - `fileName` string, required: Attached file name
    - `fileId` string, uuid, required: ID of attached file
    - `statusId` integer: Status ID of the attachment
    - `resourcePath` string: Resource path of the attachment

## Response `201`

Created

- PrivacyAutomationDataSubjectRequestDSRAutomationRequestQueueV2Dto
  - `requestQueueRefId` string: Reference ID of the request. This is a 10-character ID that is unique to each request.
  - `requestQueueId` string, uuid: The request GUID
  - `firstName` string: First name of the data subject.
  - `lastName` string: Last name of the data subject.
  - `organization` string: Organization to which this request is assigned.
  - `status` string: Current stage of the request. Various stages in the order of progression are: New, Verifying identity, In progress, Rejected, Complete.
  - `requestTypes` string[]: Request types selected while submitting the request.
  - `deadline` string, date-time: Deadline for the request.
  - `isExtended` boolean: Returns true if the request complete time is being extended.
  - `dateCreated` string, date-time: Date on which request is submitted.
  - `dateUpdated` string, date-time: Last activity date on the request.
  - `subjectTypes` string[]: Subject types selected while submitting the request. Subject type can be: Prospective Employee, Student, Customer, Contractor, Employee, Patient.
  - `approver` string: Approver or assignee for the request.
  - `language` string: Language in which the request is created.
  - `countryCode` string: The code for the country as per ISO 3166. e.g. US for the United States, DE for Germany.
  - `countryName` string: Name of the country.
  - `email` string: Email provided while submitting the request.
  - `workflow` string: Name of the request workflow.
  - `webform` string: Name of the webform.
  - `dateCompleted` string, date-time: Date on which the request is completed.
  - `resolution` string: Resolution selected if the request is rejected.
  - `remainingDaysForMaxDeadline` integer: Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.
  - `maxDeadlineExtensionDate` string, date-time: Legal Deadline + Maximum Number of Extension Days based on country of request + Total Pause days.
  - `assignedToGroup` boolean: Indicates if the request reviewer is assigned to a usergroup or not.
  - `additionalStatuses` '0' | '10': Status of the request timer, such as PAUSED or ACTIVE.
  - `legalDeadLineInfo` PrivacyAutomationDataSubjectRequestDSRAutomationRequestQueueListDto
    - `firstName` string
    - `lastName` string
    - `email` string
    - `requestQueueId` string, uuid
    - `requestQueueRefId` string
    - `orgGroupId` string, uuid
    - `daysLeft` integer
    - `status` integer
    - `dateCreated` string, date-time
    - `isExtended` boolean
    - `reviewer` string
    - `reviewerId` string, uuid
    - `language` string
    - `templateId` string, uuid
    - `currentStage` string
    - `requestTypes` string[]
    - `subjectTypes` string[]
    - `deadline` string, date-time
    - `workflowDetailDto` PrivacyAutomationDataSubjectRequestDSRAutomationRequestQueueWorkflowDetailDto
      - `stage` string
      - `allowRequestQueueUpdate` boolean
      - `beginDeadlineCalc` boolean
      - `allowDeadlineEdit` boolean
    - `totalSubtasks` integer
    - `completedSubtasks` integer
    - `remainingSubtasks` integer
    - `dsLanguageName` string
    - `webformName` string
    - `workflowName` string
    - `workflowReferenceId` string, uuid
    - `resolution` string
    - `lastUpdated` string, date-time
    - `authEnabled` boolean
    - `lastPublicCommentDate` string, date-time
    - `lastDSReplyDate` string, date-time
    - `state` string
    - `country` string
    - `closureDate` string, date-time
    - `countryCode` string
    - `webFormVersion` integer
    - `remainingDaysForMaxDeadline` integer
    - `numberOfLinkedRequests` integer
    - `maxDeadlineExtensionDate` string, date-time
    - `selectFields` object
      - `all` object
      - `empty` boolean
    - `inputFields` object
    - `totalDataCount` integer
    - `retentionStatus` integer
    - `resultsSummaryDataCount` PrivacyAutomationDataSubjectRequestDSRAutomationResultsSummaryDataCountDto
      - `dataPoints` integer
      - `unstructuredData` integer
      - `attachments` integer
      - `excluded` integer
    - `slaExceeded` string
    - `visited` boolean
    - `attentionRequired` boolean
    - `seededOtherData` object
    - `lastDsAccessDate` string, date-time
    - `assignedTogroup` boolean
    - `additionalStatuses` '0' | '10'
    - `daysPaused` number, double
    - `dsAccessRevoked` boolean
    - `testRequest` boolean
    - `taskMode` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/privacy-automation-data-subject-request-dsr-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/privacy-automation-data-subject-request-dsr-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/privacy-automation-data-subject-request-dsr-automation/revisions/612f0b39b904?raw)