update_identity_custom_field
Update an existing identity custom field. Modify its display name and unique code.
Instructions
Update an existing identity custom field configuration. Can modify field name and code.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customFieldId | Yes | The ID of the custom field to update | |
| attributeName | No | Display label for the custom field | |
| attributeCode | No | Unique identifier for the custom field. Must contain only lowercase letters, numbers, and underscores. |
Implementation Reference
- The main handler function that executes the update_identity_custom_field tool logic. It builds a request body from optional params (attributeName, attributeCode) and makes a PATCH API call to /identity/fields/custom/{customFieldId}.
export async function updateIdentityCustomField(params: UpdateIdentityCustomFieldParams) { const client = getClient(); const body: Record<string, unknown> = {}; if (params.attributeName !== undefined) body.attributeName = params.attributeName; if (params.attributeCode !== undefined) body.attributeCode = params.attributeCode; return client.makePatchApiCall(`/identity/fields/custom/${params.customFieldId}`, body); } - Zod schema defining the input parameters: customFieldId (required number), attributeName (optional string), attributeCode (optional string matching lowercase letters, numbers, underscores).
export const UpdateIdentityCustomFieldSchema = z.object({ customFieldId: z.number().describe("The ID of the custom field to update"), attributeName: z.string().optional().describe("Display label for the custom field"), attributeCode: z .string() .optional() .describe("Unique identifier for the custom field. Must contain only lowercase letters, numbers, and underscores."), });