Skip to Content
API ReferenceQuick Replies

Quick Reply APIs

Overview

A quick reply is a saved message snippet that agents reuse in the inbox. Each quick reply pairs a command, a short keyword such as welcome, with the content to insert.

In the inbox, typing / at the start of the message box opens the quick reply picker. Typing more characters filters the list to commands that start with them (case-insensitive), so /wel finds welcome. Picking an item replaces the draft with the quick reply content. The agent can edit it, and nothing reaches the client until the agent sends the message. You can also manage quick replies in the portal under Quick Replies.

  • Commands are unique per workspace. Two quick replies can’t share the same command. The check is an exact, case-sensitive match after trimming, so Welcome and welcome are different commands.
  • Store commands without the leading /. The portal strips leading slashes before saving, and the picker adds one when it shows the command. The API saves the trimmed value as-is, so welcome and /welcome would be two quick replies that look the same in the picker.
  • Values are trimmed. Leading and trailing whitespace is removed from command and content, and empty values are rejected. Line breaks inside content are kept.
  • Who can do what. Any workspace member can list quick replies. Creating, editing and deleting them needs the MANAGE_WORKSPACE permission (Owner, Admin).

Quick reply properties

PropertyTypeDescription
workspaceIdnumber

The workspace ID.

idstring

The quick reply ID.

commandstring

The keyword agents type after / in the inbox to find this quick reply. Unique within the workspace.

contentstring

The text that replaces the message draft when an agent picks this quick reply.

createdAtDateTime

The created timestamp.

updatedAtDateTime

The last updated timestamp.

List Quick Replies API

Get all quick replies of a workspace, sorted by command in ascending order. The list is not paginated.

Access: Any role on the workspace. Works with workspace API keys and agent API keys.

AttributeTypeDescription
workspaceIdnumber

Required. The workspace ID.

Request & Response

POST https://gateway.bcrumbs.net/core/gq
query quickReplies($input: QuickRepliesInput!) { quickReplies(input: $input) { nodes { id command content createdAt updatedAt } } } input QuickRepliesInput { workspaceId: Int! # Workspace ID. }

The query above returns JSON structured like this:

{ "data": { "quickReplies": { "nodes": [ { "id": "quickreply_456", "command": "hours", "content": "We're open Sunday to Thursday, 9:00 to 18:00.", "createdAt": "2026-09-02T08:15:00.000Z", "updatedAt": "2026-09-02T08:15:00.000Z" }, { "id": "quickreply_123", "command": "welcome", "content": "Hi! Thanks for contacting us. How can we help you today?", "createdAt": "2026-08-20T10:00:00.000Z", "updatedAt": "2026-10-17T09:30:00.000Z" } ] } } }
You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \ -H 'authorization: API-KEY' \ -H 'content-type: application/json' \ -d '{"operationName":"quickReplies","variables":{"input":{"workspaceId":12}},"query":"query quickReplies($input: QuickRepliesInput!) {\n quickReplies(input: $input) {\n nodes {\n id\n command\n content\n createdAt\n updatedAt\n }\n }\n}"}'

Create Quick Reply API

Create a quick reply in a workspace. command and content are trimmed, and command must not be used by another quick reply in the same workspace. Send the command without the leading /.

Access: MANAGE_WORKSPACE (Owner, Admin). Works with workspace API keys. Agent API keys are rejected.

AttributeTypeDescription
workspaceIdnumber

Required. The workspace ID.

commandstring

Required. The keyword agents type after / in the inbox, for example welcome. Must be unique within the workspace (exact, case-sensitive match after trimming).

contentstring

Required. The text that replaces the message draft when an agent picks this quick reply.

Request & Response

POST https://gateway.bcrumbs.net/core/gq
mutation addQuickReply($input: QuickReplyAddInput!) { addQuickReply(input: $input) { id command content createdAt updatedAt } } input QuickReplyAddInput { workspaceId: Int! # Workspace ID. command: String! # Keyword typed after "/" in the inbox. Unique per workspace. content: String! # Text inserted into the message box. }

The mutation above returns JSON structured like this:

{ "data": { "addQuickReply": { "id": "quickreply_123", "command": "welcome", "content": "Hi! Thanks for contacting us. How can we help you today?", "createdAt": "2026-10-17T09:30:00.000Z", "updatedAt": "2026-10-17T09:30:00.000Z" } } }
ErrorCause
Command is required.command is empty or only whitespace.
Content is required.content is empty or only whitespace.
A database unique-constraint errorAnother quick reply in the workspace already uses this command.
You do not have permission to access this resource with your current role assignmentThe caller’s role doesn’t have MANAGE_WORKSPACE, or the call uses an agent API key.
You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \ -H 'authorization: API-KEY' \ -H 'content-type: application/json' \ -d '{"operationName":"addQuickReply","variables":{"input":{"workspaceId":12,"command":"welcome","content":"Hi! Thanks for contacting us. How can we help you today?"}},"query":"mutation addQuickReply($input: QuickReplyAddInput!) {\n addQuickReply(input: $input) {\n id\n command\n content\n createdAt\n updatedAt\n }\n}"}'

Patch Quick Reply API

Update the command, the content, or both of a quick reply. Omit a field to keep its current value. If you send neither field, the quick reply is returned unchanged. New values are trimmed and checked the same way as on create.

Access: MANAGE_WORKSPACE (Owner, Admin). Works with workspace API keys. Agent API keys are rejected.

AttributeTypeDescription
workspaceIdnumber

Required. The workspace ID.

idstring

Required. The quick reply ID.

commandstring

The new command. Must be unique within the workspace and can't be empty. Omit it to keep the current command. Don't send null.

contentstring

The new content. Can't be empty. Omit it to keep the current content. Don't send null.

Request & Response

POST https://gateway.bcrumbs.net/core/gq
mutation patchQuickReply($input: QuickReplyPatchInput!) { patchQuickReply(input: $input) { id command content createdAt updatedAt } } input QuickReplyPatchInput { workspaceId: Int! # Workspace ID. id: ID! # Quick reply ID. command: String # New command. Omit to keep the current one. content: String # New content. Omit to keep the current one. }

The mutation above returns JSON structured like this:

{ "data": { "patchQuickReply": { "id": "quickreply_123", "command": "welcome", "content": "Hi! Thanks for contacting us. An agent will reply within a few minutes.", "createdAt": "2026-08-20T10:00:00.000Z", "updatedAt": "2026-10-17T09:30:00.000Z" } } }
ErrorCause
Command is required.command was sent as an empty or whitespace-only string.
Content is required.content was sent as an empty or whitespace-only string.
A database unique-constraint errorAnother quick reply in the workspace already uses the new command.
A database record-not-found errorNo quick reply with this id exists in the workspace.
You do not have permission to access this resource with your current role assignmentThe caller’s role doesn’t have MANAGE_WORKSPACE, or the call uses an agent API key.
You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \ -H 'authorization: API-KEY' \ -H 'content-type: application/json' \ -d '{"operationName":"patchQuickReply","variables":{"input":{"workspaceId":12,"id":"quickreply_123","content":"Hi! Thanks for contacting us. An agent will reply within a few minutes."}},"query":"mutation patchQuickReply($input: QuickReplyPatchInput!) {\n patchQuickReply(input: $input) {\n id\n command\n content\n createdAt\n updatedAt\n }\n}"}'

Delete Quick Reply API

Permanently delete a quick reply and return the deleted record.

Access: MANAGE_WORKSPACE (Owner, Admin). Works with workspace API keys. Agent API keys are rejected.

AttributeTypeDescription
workspaceIdnumber

Required. The workspace ID.

idstring

Required. The quick reply ID.

Request & Response

POST https://gateway.bcrumbs.net/core/gq
mutation removeQuickReply($input: QuickReplyRemoveInput!) { removeQuickReply(input: $input) { id command } } input QuickReplyRemoveInput { workspaceId: Int! # Workspace ID. id: ID! # Quick reply ID. }

The mutation above returns JSON structured like this:

{ "data": { "removeQuickReply": { "id": "quickreply_123", "command": "welcome" } } }
ErrorCause
A database record-not-found errorNo quick reply with this id exists in the workspace (for example, it was already deleted).
You do not have permission to access this resource with your current role assignmentThe caller’s role doesn’t have MANAGE_WORKSPACE, or the call uses an agent API key.
You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \ -H 'authorization: API-KEY' \ -H 'content-type: application/json' \ -d '{"operationName":"removeQuickReply","variables":{"input":{"workspaceId":12,"id":"quickreply_123"}},"query":"mutation removeQuickReply($input: QuickReplyRemoveInput!) {\n removeQuickReply(input: $input) {\n id\n command\n }\n}"}'