Create Compliance Job

Creates a new Compliance Job for the specified job type.

POST /2/compliance/jobs

Try it

Create Compliance Job

cURL

curl --request POST \
  --url https://api.x.com/2/compliance/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "tweets",
  "name": "my-job",
  "resumable": true
}
'

200

{
  "data": {
    "created_at": "2021-01-06T18:40:40.000Z",
    "download_expires_at": "2021-01-06T18:40:40.000Z",
    "download_url": "<string>",
    "id": "1372966999991541762",
    "status": "created",
    "type": "tweets",
    "upload_expires_at": "2021-01-06T18:40:40.000Z",
    "upload_url": "<string>",
    "name": "my-job"
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A request to create a new batch compliance job.

type · enum<string> · required

Type of compliance job to list.

Available options: tweets, users

name · string

User-provided name for a compliance job.

Maximum string length: 64

Example:

"my-job"

resumable · boolean

If true, this endpoint will return a pre-signed URL with resumable uploads enabled.

Response

200

application/json

The request has succeeded.

data · object

Show child attributes

data. created_at · string<date-time> · required

Creation time of the compliance job.

Example:

"2021-01-06T18:40:40.000Z"

data. download_expires_at · string<date-time> · required

Expiration time of the download URL.

Example:

"2021-01-06T18:40:40.000Z"

data. download_url · string<uri> · required

URL from which the user will retrieve their compliance results.

data. id · string · required

Compliance Job ID.

Example:

"1372966999991541762"

data. status · enum<string> · required

Status of a compliance job.

Available options: created, in_progress, failed, complete, expired

data. type · enum<string> · required

Type of compliance job to list.

Available options: tweets, users

data. upload_expires_at · string<date-time> · required

Expiration time of the upload URL.

Example:

"2021-01-06T18:40:40.000Z"

data. upload_url · string<uri> · required

URL to which the user will upload their Tweet or user IDs.

data. name · string

User-provided name for a compliance job.

Maximum string length: 64

Example:

"my-job"

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer