Create a chat message link
POST/chat.link.create
Create a shareable Roam link to a specific chat message. Opening the link in Roam navigates to that message in its chat.
Identify the chat with exactly one of chatId, groupId, or userIds,
and the message by its timestamp (Unix microseconds), as returned by
/chat.history, /chat.post,
or webhook message events. For a thread reply, also pass the thread root's
timestamp as threadTimestamp — without it the reply will not be found.
The message must exist and be readable by the caller; otherwise no link is
returned (404 if the message does not exist, 403 if the caller is not a
member of the chat). The link itself does not grant access: recipients can
only open it if they are members of the chat.
Use /chat.link.resolve for the reverse
operation — turning a Roam chat link back into the referenced message.
Access: Organization and Personal. In Personal mode, only chats the authenticated user can access are allowed.
Required scope: chat:history
OpenAPI Spec: chat-v1.json
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 500
Link created successfully.
Bad request. Common causes:
- Missing
timestamp - Timestamps that are not positive microseconds
- Missing or multiple destinations (
chatId,groupId,userIds) - Destination cannot be resolved to a chat
Presented invalid authentication credentials.
Caller is not a member of this chat.
No message exists at the given timestamp. For thread replies, include threadTimestamp.
An unsupported method was requested.
An internal error occurred.