Docs: Tool reference
admin toolset

delete_custom_field

Delete a custom field. Deletes a custom field and takes it off board forms. A post field's values are cleared from every post; user and company attributes with its key stay as plain attributes. Destructive: confirm: true, or dry_run: true to see how many posts lose a value. Nobody is emailed.

Toolset
admin
Who can call it
OwnersManagersAPI keys
REST
DELETE /api/v1/w/{workspace}/custom-fields/{field}
Behavior
changes datadestructive (confirm: true, dry_run)

Input

FieldTypeDescription
fieldrequiredstringThe field's ID (fld_…), or its key together with entity.
entityone of: post, user, companyWhat the field describes: post, user or company.
confirmbooleanMust be true to perform this destructive action, unless dry_run is true.
dry_runbooleanPreview the result without changing anything.

Output

FieldTypeDescription
fieldrequiredobject
posts_clearedrequiredinteger

Calling it

// MCP: tools/call
{ "name": "delete_custom_field", "arguments": {"field":"<string>"} }

// Typed client
await carechannel.delete_custom_field({"field":"<string>"});