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": {
    "classification": "misinformed_or_potentially_misleading",
    "misleading_tags": [
      "disputed_claim_as_fact"
    ],
    "text": "<string>",
    "trustworthy_sources": true,
    "is_media_note": true
  },
  "post_id": "1346889436626259968",
  "test_mode": true
}
'
{
  "data": {
    "id": "1146654567674912769"
  },
  "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

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