User notes¶

A note is short private text the caller stores about another account.

All routes on this page are user-only. They require a user session token (Authorization: Bearer <token>). A valid Bot <token> credential is refused with 403 ACCESS_DENIED, and an invalid one with 401 UNAUTHORIZED.

User note object¶

The note the caller holds for one target account.

Structure¶

A stored note is never empty: writing an empty or whitespace-only note deletes it instead.

User notes record¶

Every note the caller has stored, as a map from target account ID to note text.

Structure¶

A target with no note has no property, so an account with no notes receives {"notes": {}}.

The Gateway delivers the same map (without the notes wrapper) as the notes field of the Ready payload, so a connected client already holds it before calling List user notes.

Example¶

{
  "notes": {
    "1501314428688998182": "met at the Berlin meetup",
    "1501314428688998183": "always posts the good links"
  }
}

List user notes¶

GET /users/@me/notes

Returns the caller's complete user notes record. The operation is not paged, so every stored note comes back in one response.

A note has no creation or modification timestamp.

Response¶

Rate limit¶

60 requests per 10 seconds for each authenticated user, on the user:notes:read bucket, shared with Get user note.

Get user note¶

GET /users/@me/notes/{target_id}

Returns the caller's user note object for one target account.

A target with no stored note returns 200 with an empty note, not an error. TEBHOS does not check that the target account exists, so an unknown ID behaves the same way.

Path parameters¶

Response¶

Example¶

{
  "note": "met at the Berlin meetup"
}

Rate limit¶

60 requests per 10 seconds for each authenticated user, on the user:notes:read bucket, shared with List user notes.

Set user note¶

PUT /users/@me/notes/{target_id}

Creates, replaces, or deletes the caller's note for one target account. Returns the submitted note. Emits a User Note Update Gateway event.

The supplied text becomes the complete stored note. Leading and trailing whitespace is removed before it is stored. The caller can store a note for any ID, including a bot account and its own account; TEBHOS does not check that the target exists.

Path parameters¶

JSON body¶

The 256-character limit is counted in Unicode characters on the value as sent, before whitespace is trimmed.

Response¶

Side effects¶

Supplying text creates or replaces the note, and a request that supplies none deletes it. User Note Update reaches the caller's own sessions for every accepted request, including one that supplies the current value and one that deletes an absent note.

The Dispatch payload has these members:

Rate limit¶

40 requests per 10 seconds for each authenticated user, on the user:notes:write bucket.

Legacy note route¶

POST /profile/{profile_id}/note

An older route kept for earlier TEBHOS clients. It takes the same {"note": ...} body and writes to the same storage as Set user note, so blank values delete the note and text is trimmed before it is stored. It returns 200 with {"message": ..., "note": ...}.