Skip to main content
POST
/
2
/
compliance
/
jobs
Create Compliance Job
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
}
'
{
  "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

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

The request has succeeded.

​
data
object
​
errors
object[]
Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).