openapi: 3.2.0
info:
  title: Consent & Preferences - Universal Consent & Preference…
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: The Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform.
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:
- name: Jobs
  description: The Jobs APIs are used to manage scheduled jobs for bulk actions.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json
  x-displayName: Jobs
paths:
  /rest/api/consent/v4/jobs:
    post:
      operationId: createJobUsingPOST
      summary: Create Job
      description: Use this API to create a new schedule job for data subject bulk actions.
      tags:
      - Jobs
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentAPI_JobCreateRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentAPI_JobResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: string
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - ConsentAPI_OAUTH2:
        - CONSENT
components:
  schemas:
    ConsentAPI_JobResponse:
      type: object
      properties:
        Id:
          description: The unique identifier of the scheduled job.
          type: string
          format: uuid
          example: 1053400f-2a31-49cc-b164-3de08506ab6e
        Name:
          description: The name of the job.
          type: string
          example: job 1234
        Description:
          description: The description of the job.
          type: string
        TypeId:
          description: The type of job.
          type: string
          example: consent_ds_bulk_actions
        Status:
          description: The status of the job.
          type: string
          example: Pending
          enum:
          - Pending
          - In Progress
          - Error
          - Completed
        StatusId:
          description: The numeric status identifier of the job.
          type: integer
          format: int32
          example: 1
        ErrorCount:
          description: The number of errors encountered during job execution.
          type: integer
          format: int32
          example: 0
        CreatedBy:
          description: The unique identifier of the user who created the job.
          type: string
          format: uuid
          example: 16eb22c4-415d-4852-ba36-1567a1bd277d
        CreatedDate:
          description: The date and time that the job was created.
          type: string
          format: date-time
          example: '2026-02-11T06:32:23.769+00:00'
    ConsentAPI_JobCreateRequest:
      type: object
      properties:
        EntityId:
          description: The unique identifier of the entity for which the job is being created.
          type: string
          example: 478059e6-97ff-4080-ae18-46989056fabb
        Name:
          description: The name of the job.
          type: string
          example: import123
        Description:
          description: The description of the job.
          type: string
          example: Bulk import of consent data subjects
        Type:
          description: The type of job.
          type: string
          enum:
          - consent_ds_bulk_actions
        Token:
          description: The authentication token required to execute the job.
          type: string
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
      required:
      - EntityId
      - Name
      - Token
  securitySchemes:
    ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONSENT: Consent Scope gives the user access to read/write operations
            CONSENT_READ: Consent Read Scope gives the user read-only access
    ConsentAPI_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONSENT: Consent Scope gives the user access to read/write operations
            CONSENT_READ: Consent Read Scope gives the user read-only access
    DSPreferneceCache_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONSENT: Consent Scope gives the user access to read/write operations
            CONSENT_READ: Consent Read Scope gives the user read-only access
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0