POST/api/canned-responses/categories

Creates a category for grouping canned responses in the authenticated organization. At least one localized name is required. The response includes the category's locale lifecycle metadata.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: canned-responses:write
Module: Automation & API module (automation_api)
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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

Response Body

`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",
      "sourceLocale": null,
      "machineTranslatedAt": null,
      "reviewedAt": null,
      "reviewedBy": null,
      "name": "Billing",
      "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"
  }
}

Request examples

curl

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"
    }
  ]
}'

JavaScript

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 category

Creates a category for grouping canned responses in the authenticated organization.

POST/api/canned-responses/categories

Creates a category for grouping canned responses in the authenticated organization. At least one localized name is required. The response includes the category's locale lifecycle metadata.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: canned-responses:write
Module: Automation & API module (automation_api)
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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

key?string

Stable machine-readable key.

sortOrder?integer

Direction used to sort the results.

translations*array<>

Localized variants for this resource.

Response Body

`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",
      "sourceLocale": null,
      "machineTranslatedAt": null,
      "reviewedAt": null,
      "reviewedBy": null,
      "name": "Billing",
      "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"
  }
}

Request examples

curl

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"
    }
  ]
}'

JavaScript

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 category

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Create a localized canned response category

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Create a localized canned response category

Endpoint requirements

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Create a localized canned response category

Endpoint requirements

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`