API ReferenceCustom Fields
Update multilingual custom field content
Partially updates a custom field definition.
PATCH
/api/custom-fields/{id}Partially updates a custom field definition. The field name, type, and target cannot change. Supplied translations or select options replace their complete localized sets; omitted properties remain unchanged.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
custom-fields: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
Resource identifier.
Match
^([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)$Format
uuidRequest 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": "42880ce7-4d1d-469d-a63e-fd75f2c3e96e", "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5", "projectScope": "all", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "name": "account_tier", "type": "select", "required": true, "target": "conversation", "sortOrder": 20, "active": true, "label": "Account tier", "placeholder": "Choose a tier", "validationMessage": null, "locale": "en", "fallbackUsed": false, "options": [ { "id": "d879cc4e-11ce-46f3-be45-47d20de0a48f", "value": "enterprise", "sortOrder": 0, "label": "Enterprise", "locale": "en", "fallbackUsed": false, "translations": [ { "id": "fc094ad3-b971-438f-9884-ae47e3581e4c", "locale": "en", "status": "published", "sourceLocale": null, "machineTranslatedAt": null, "reviewedAt": null, "reviewedBy": null, "createdAt": "2026-08-03T18:00:00.000Z", "updatedAt": "2026-08-03T18:00:00.000Z", "label": "Enterprise" } ], "createdAt": "2026-08-04T10:00:00.000Z", "updatedAt": "2026-08-04T10:00:00.000Z" } ], "translations": [ { "id": "3ff47837-a302-466b-925d-6b53d0bbfb37", "locale": "en", "status": "published", "sourceLocale": null, "machineTranslatedAt": null, "reviewedAt": null, "reviewedBy": null, "createdAt": "2026-08-03T18:00:00.000Z", "updatedAt": "2026-08-03T18:00:00.000Z", "label": "Account tier", "placeholder": "Choose a tier", "validationMessage": null } ], "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/custom-fields/42880ce7-4d1d-469d-a63e-fd75f2c3e96e' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"required": true,
"active": true,
"sortOrder": 20
}'JavaScript
const response = await fetch("https://api.convor.io/api/custom-fields/42880ce7-4d1d-469d-a63e-fd75f2c3e96e", {
method: "PATCH",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"required": true,
"active": true,
"sortOrder": 20
}),
});
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?