API ReferenceDepartments
Update a department
Partially updates a department in the authenticated organization.
PUT
/api/departments/{id}Partially updates a department in the authenticated organization. Admin access and the departments feature are required. When the name changes, the slug is regenerated from the new name.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
departments: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
id*string
Path parameter. Unique identifier of this resource.
Match
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$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
{ "id": "550e8400-e29b-41d4-a716-446655440000", "orgId": "11111111-1111-4111-8111-111111111111", "projectScope": "all", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "name": "Billing and Payments", "slug": "billing-and-payments", "description": "Handles invoices, subscriptions, and refunds.", "isDefault": false, "locale": "en", "fallbackUsed": true, "translations": [ { "id": "11111111-1111-4111-8111-111111111111", "locale": "en", "status": "draft", "sourceLocale": "en", "machineTranslatedAt": "2026-08-04T10:00:00.000Z", "reviewedAt": "2026-08-04T10:00:00.000Z", "reviewedBy": "example", "name": "Example name", "description": "example", "createdAt": "2026-08-04T10:00:00.000Z", "updatedAt": "2026-08-04T10:00:00.000Z" } ], "createdAt": "2026-06-23T08:00:00.000Z", "updatedAt": "2026-06-23T09:00:00.000Z"}Request examples
curl
curl --request PUT \
'https://api.convor.io/api/departments/550e8400-e29b-41d4-a716-446655440000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"projectScope": "all",
"projectIds": [],
"slug": "billing-and-payments",
"isDefault": false,
"translations": [
{
"locale": "en",
"status": "published",
"name": "Billing and Payments",
"description": "Handles invoices, subscriptions, and refunds."
}
]
}'JavaScript
const response = await fetch("https://api.convor.io/api/departments/550e8400-e29b-41d4-a716-446655440000", {
method: "PUT",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"projectScope": "all",
"projectIds": [],
"slug": "billing-and-payments",
"isDefault": false,
"translations": [
{
"locale": "en",
"status": "published",
"name": "Billing and Payments",
"description": "Handles invoices, subscriptions, and refunds."
}
]
}),
});
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?