v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Jobs

Create Job

Use this API to create a new schedule job for data subject bulk actions.

post/rest/api/consent/v4/jobs

Request body

EntityIdstring required

The unique identifier of the entity for which the job is being created.

Namestring required

The name of the job.

Descriptionstring

The description of the job.

Type'consent_ds_bulk_actions'

The type of job.

Tokenstring required

The authentication token required to execute the job.

Example request

{
  "EntityId": "478059e6-97ff-4080-ae18-46989056fabb",
  "Name": "import123",
  "Description": "Bulk import of consent data subjects",
  "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response

Idstring uuid

The unique identifier of the scheduled job.

Namestring

The name of the job.

Descriptionstring

The description of the job.

TypeIdstring

The type of job.

Status'Pending' | 'In Progress' | 'Error' | 'Completed'

The status of the job.

StatusIdinteger

The numeric status identifier of the job.

ErrorCountinteger

The number of errors encountered during job execution.

CreatedBystring uuid

The unique identifier of the user who created the job.

CreatedDatestring date-time

The date and time that the job was created.

Example response

{
  "Id": "1053400f-2a31-49cc-b164-3de08506ab6e",
  "Name": "job 1234",
  "TypeId": "consent_ds_bulk_actions",
  "Status": "Pending",
  "StatusId": 1,
  "CreatedBy": "16eb22c4-415d-4852-ba36-1567a1bd277d",
  "CreatedDate": "2026-02-11T06:32:23.769+00:00"
}