Update a localized canned response
Partially updates a canned response in the authenticated organization.
/api/canned-responses/{id}Partially updates a canned response in the authenticated organization. Supplied translations and shortcuts replace their complete locale sets; omitted fields remain unchanged. Moving the response requires a destination category from the same organization.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
canned-responses:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.
Path Parameters
Resource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "998ea84d-22c1-43aa-bfd5-9e110cb36c01", "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5", "key": "refund-approved", "categoryId": "b8ec53aa-0ca2-49bb-b8f6-7458ab50260c", "category": "Billing", "locale": "en", "title": "Refund approved", "content": "Your refund has been approved and will be processed shortly.", "shortcut": "/refund-approved", "fallbackUsed": false, "active": false, "tags": [ "billing", "archived" ], "usageCount": 0, "lastUsedAt": null, "sortOrder": 10, "projectScope": "all", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "translations": [ { "id": "7ff62fc6-c0ac-49e9-8419-f68b6d845aa0", "locale": "en", "status": "published", "sourceLocale": null, "machineTranslatedAt": null, "reviewedAt": null, "reviewedBy": null, "title": "Refund approved", "content": "Your refund has been approved and will be processed shortly.", "createdAt": "2026-08-03T18:00:00.000Z", "updatedAt": "2026-08-03T18:00:00.000Z" } ], "shortcuts": [ { "id": "b58be6ea-6f19-409e-a9a6-985c5c399ee0", "locale": "en", "shortcut": "/refund-approved", "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:10:00.000Z"}Request examples
curl
curl --request PATCH \
'https://api.convor.io/api/canned-responses/998ea84d-22c1-43aa-bfd5-9e110cb36c01' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"active": false,
"tags": [
"billing",
"archived"
]
}'JavaScript
const response = await fetch("https://api.convor.io/api/canned-responses/998ea84d-22c1-43aa-bfd5-9e110cb36c01", {
method: "PATCH",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"active": false,
"tags": [
"billing",
"archived"
]
}),
});
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?