Skip to content
View as Markdown

PUT Rename Company Custom Field Group​

PUT
/companies/custom-fields/update_group_name

Rename a company custom-field group, moving every field assigned to old_name over to new_name in one operation.

Groups are not standalone records — they exist only as a label on each custom field — so this endpoint is the only way to rename one without editing every field individually.

The full updated field set is returned so the caller can refresh without a second request.

Required capability: fcrm_manage_contact_cats

Enforced by CompanyPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Request Body​

application/json
JSON
{
"old_name": "string",
"new_name": "string"
}

Responses​

Group renamed.

application/json
JSON
{
"fields": [
{
"slug": "string",
"label": "string",
"type": "string",
"group": "string"
}
],
"message": "string"
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI