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 '
{
  "name": "my-job",
  "resumable": true
}
'
import requests

url = "https://api.x.com/2/compliance/jobs"

payload = {
    "name": "my-job",
    "resumable": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'my-job', resumable: true})
};

fetch('https://api.x.com/2/compliance/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.x.com/2/compliance/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'my-job',
    'resumable' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.x.com/2/compliance/jobs"

	payload := strings.NewReader("{\n  \"name\": \"my-job\",\n  \"resumable\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.x.com/2/compliance/jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-job\",\n  \"resumable\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/compliance/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my-job\",\n  \"resumable\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "created_at": "2021-01-06T18:40:40.000Z",
    "download_expires_at": "2021-01-06T18:40:40.000Z",
    "download_url": "<string>",
    "id": "1372966999991541762",
    "upload_expires_at": "2021-01-06T18:40:40.000Z",
    "upload_url": "<string>",
    "name": "my-job"
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}
{
  "code": 123,
  "message": "<string>"
}

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).