Creates an organization-owned category used to group canned responses. At least one localized category name is required; locale lifecycle metadata is persisted and cached category lists are invalidated. Access requires an active organization administrator session or an organization API key with the `canned-responses:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
/api/canned-responses/categoriesOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"id": "b8ec53aa-0ca2-49bb-b8f6-7458ab50260c",
"orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
"key": "billing",
"sortOrder": 10,
"name": "Billing",
"locale": "en",
"fallbackUsed": false,
"responseCount": 1,
"translations": [
{
"id": "5ed35c91-5633-4745-8f00-317104590fa8",
"locale": "en",
"status": "published",
"name": "Billing",
"sourceLocale": null,
"machineTranslatedAt": null,
"reviewedAt": null,
"reviewedBy": null,
"createdAt": "2026-08-03T18:00:00.000Z",
"updatedAt": "2026-08-03T18:00:00.000Z"
}
],
"createdAt": "2026-08-03T18:00:00.000Z",
"updatedAt": "2026-08-03T18:00:00.000Z"
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"correlationId": "req_01K0MANAGEMENT401"
}
}{
"error": {
"code": "INTEGRATION_MODULE_REQUIRED",
"message": "The automation API module is required.",
"details": {
"module": "automation_api",
"feature": "public_api"
},
"correlationId": "req_01K0MANAGEMENT402"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The caller lacks the required role or API-key scope.",
"correlationId": "req_01K0MANAGEMENT403"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with current resource state.",
"correlationId": "req_01K0MANAGEMENT409"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request payload is invalid.",
"details": {
"field": "name"
},
"correlationId": "req_01K0MANAGEMENT422"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests.",
"correlationId": "req_01K0MANAGEMENT429"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request POST \
'https://api.convor.io/api/canned-responses/categories' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"key": "billing",
"sortOrder": 10,
"translations": [
{
"locale": "en",
"status": "published",
"name": "Billing"
}
]
}'const response = await fetch("https://api.convor.io/api/canned-responses/categories", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"key": "billing",
"sortOrder": 10,
"translations": [
{
"locale": "en",
"status": "published",
"name": "Billing"
}
]
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?
Create a localized canned response
Creates one reusable response in an organization-owned category, including localized title/content variants, locale-specific slash shortcuts, tags, and active state. The new item is immediately available to operators and invalidates the organization canned-response cache. Access requires an active organization administrator session or an organization API key with the `canned-responses:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
Delete a canned response
Permanently deletes one organization-owned canned response together with its translations and shortcuts, then invalidates cached lists. Existing conversation messages created from the response are not changed. Access requires an active organization administrator session or an organization API key with the `canned-responses:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.