Browse docs

Quick Replies

Overview

Quick replies can be personal or shared with a workspace. Every member can list and read their own personal replies and the workspace's shared replies. Members can create, update, and delete their own personal replies. Only workspace administrators can create, update, or delete shared replies.

List Quick Replies

GET /api/quick-replies

Example Response

{
    "data": [
        {
            "id": 1,
            "ulid": "01hx9f3k2a...",
            "name": "Greeting",
            "body": "Hi, thanks for reaching out.",
            "scope": "personal"
        }
    ]
}

Show Quick Reply

GET /api/quick-replies/{quickReply}

Create Quick Reply

POST /api/quick-replies

Request Body

Field Type Required
name string Yes
body string Yes
scope string No

Set scope to personal (the default) or workspace. Creating a workspace reply requires workspace administrator permissions. Shared replies belong only to the active workspace.

Update Quick Reply

PUT /api/quick-replies/{quickReply}

Send name, body, or both. A reply's scope cannot be changed when updating it.

Delete Quick Reply

DELETE /api/quick-replies/{quickReply}