Skip to main content
POST
/
2
/
notes
Create a Community Note
curl --request POST \
  --url https://api.x.com/2/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "info": {
    "misleading_tags": [],
    "text": "<string>",
    "trustworthy_sources": true,
    "is_media_note": true
  },
  "post_id": "1346889436626259968",
  "test_mode": true
}
'
import requests

url = "https://api.x.com/2/notes"

payload = {
    "info": {
        "misleading_tags": [],
        "text": "<string>",
        "trustworthy_sources": True,
        "is_media_note": True
    },
    "post_id": "1346889436626259968",
    "test_mode": 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({
    info: {
      misleading_tags: [],
      text: '<string>',
      trustworthy_sources: true,
      is_media_note: true
    },
    post_id: '1346889436626259968',
    test_mode: true
  })
};

fetch('https://api.x.com/2/notes', 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/notes",
  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([
    'info' => [
        'misleading_tags' => [
                
        ],
        'text' => '<string>',
        'trustworthy_sources' => true,
        'is_media_note' => true
    ],
    'post_id' => '1346889436626259968',
    'test_mode' => 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/notes"

	payload := strings.NewReader("{\n  \"info\": {\n    \"misleading_tags\": [],\n    \"text\": \"<string>\",\n    \"trustworthy_sources\": true,\n    \"is_media_note\": true\n  },\n  \"post_id\": \"1346889436626259968\",\n  \"test_mode\": 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/notes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"info\": {\n    \"misleading_tags\": [],\n    \"text\": \"<string>\",\n    \"trustworthy_sources\": true,\n    \"is_media_note\": true\n  },\n  \"post_id\": \"1346889436626259968\",\n  \"test_mode\": true\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"info\": {\n    \"misleading_tags\": [],\n    \"text\": \"<string>\",\n    \"trustworthy_sources\": true,\n    \"is_media_note\": true\n  },\n  \"post_id\": \"1346889436626259968\",\n  \"test_mode\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "1146654567674912769"
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}
{
  "code": 123,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
info
object
required

A X Community Note is a note on a Post.

​
post_id
string
required

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Pattern: ^[0-9]{1,19}$
Example:

"1346889436626259968"

​
test_mode
boolean
required

If true, the note being submitted is only for testing the capability of the bot, and won't be publicly visible. If false, the note being submitted will be a new proposed note on the product.

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