User notes
A note is short private text you keep about another account, and only you can see it. Bots and OAuth2 tokens get 403 ACCESS_DENIED on these routes.
User note object
Section titled “User note object”Structure
Section titled “Structure”| Field | Type | Description |
|---|---|---|
| note | string | The note text for the target account (1-256 characters) |
User notes record
Section titled “User notes record”A map from target account snowflake to note text. The Gateway sends the same map in the notes field of the READY payload.
Structure
Section titled “Structure”| Field | Type | Description |
|---|---|---|
| {target_id} | string | The note text for the account with this ID |
Example
Section titled “Example”{ "1501314428688998182": "met at the Berlin meetup", "1501314428688998183": "always posts the good links"}List user notes
Section titled “List user notes”GET/v1/users/@me/notesReturns all your notes as a user notes record, or an empty object when you have none.
Response
Section titled “Response”| Status | Body | Condition |
|---|---|---|
| 200 | user notes record | Notes were returned |
The rate limit is 60 requests per 10 seconds, on the user:notes:read bucket.
Get user note
Section titled “Get user note”GET/v1/users/@me/notes/{target_id}Returns your user note for one account.
Response
Section titled “Response”| Status | Body | Condition |
|---|---|---|
| 200 | user note object | The note was returned |
| 404 | error response | UNKNOWN_USER when no note is stored for the ID |
The rate limit is 60 requests per 10 seconds, on the user:notes:read bucket.
Set user note
Section titled “Set user note”PUT/v1/users/@me/notes/{target_id}Creates, replaces or deletes your note on an account and sends a User Note Update event to your sessions.
JSON body
Section titled “JSON body”| Field | Type | Description |
|---|---|---|
| note? | ?string | The note text (1-256 characters), or null or an empty string to delete the note |
Response
Section titled “Response”| Status | Body | Condition |
|---|---|---|
| 204 | empty | The note was set or deleted |
| 403 | error response | CONTENT_BLOCKED when the text matches the instance blocklist |
| 404 | error response | UNKNOWN_USER when the account does not exist |
The rate limit is 40 requests per 10 seconds, on the user:notes:write bucket.