Post to the ticker
POST/ticker.post
Add a post to the ticker. The post is created as your integration's bot and appears to people in the Roam immediately. Posts don't expire; a post stays until someone deletes it.
The new post goes at the end of the ticker. To place it next to an existing
post, pass that post's ID as beforeId or afterId (not both). The anchor
can be any post on the ticker, whoever created it. People can reorder posts
in the Roam app and there is no endpoint to reorder them, so a post may not
stay where you put it.
The ticker holds at most 50 posts, shared by members and integrations. When
it is full, this call returns 409 ticker_full; delete a post with
ticker.delete first. There is no edit
endpoint either: to change a post, delete it and post it again.
This call is not idempotent. If a request times out and you can't tell
whether it succeeded, call ticker.list and check
for the post before retrying, or you may create a duplicate.
Access: Organization only (API Key or OAuth with admin consent).
Personal tokens, including Personal Access Tokens, get 403
access_mode_not_supported.
Required scope: ticker:write
OpenAPI Spec: chat-v1.json
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 409
- 500
Post created
Bad request. Common causes:
- Missing, empty, or too-long
categoryortext, or acategorywith uppercase letters (invalid_arguments) - A
urlthat is not anhttporhttpsURL with a domain-name host, or is longer than 2048 characters (invalid_arguments) - An empty
url(invalid_parameter,paramisurl) - A
beforeIdorafterIdthat is not a UUID (invalid_parameter,paramnames the field) - Both
beforeIdandafterId(invalid_arguments) - Malformed JSON body or an unknown field (
invalid_json)
Presented invalid authentication credentials.
Forbidden. Common causes:
- Personal token (
access_mode_not_supported) - Token is missing
ticker:write(missing_scope) - The ticker is not available in this Roam (
ticker_not_available) - An admin has turned the ticker off (
ticker_disabled)
Not found. Common causes:
beforeIdorafterIdis not a post on the ticker in this Roam (ticker_message_not_found)
An unsupported method was requested.
The ticker already has 50 posts (ticker_full). Delete a post first.
An internal error occurred.