# Update a sign-up custom field (/docs/apis/management/options/PatchSignUpCustomField)

`PATCH /options/authentication/signup/custom_fields/{claim_name}`

Applies a partial update to the specified sign-up custom field configuration. Only fields included in the request are updated.

Base URL: `https://{tenant}.{region}.monocloud.com/api`, where `{tenant}`, `{region}` (one of us, eu, in) come from your tenant. Authentication: send your Management API key in the `X-API-KEY` header.

## Parameters

- `claim_name` (path) (string, required) The unique claim name identifying the custom field.

## Request body

JSON, required. The request payload used to update the field configuration.

- `enabled` (boolean) Specifies whether this custom field is enabled and shown during sign-up.
- `required` (boolean) Specifies whether this custom field is mandatory during sign-up.
- `claim_name` (string) The claim name under which the value will be stored.
- `value_type` (string) The data type of the claim value. One of: `string`, `email`, `phone`.
- `label` (string) The user-facing label displayed for this field during sign-up.

## Response body

`200`, JSON. The sign-up custom field was updated successfully

Returns `SignUpCustomField`.

- `enabled` (boolean, required) Specifies whether this custom field is enabled and shown during sign-up.
- `required` (boolean, required) Specifies whether this custom field is mandatory during sign-up.
- `claim_name` (string, required) The claim name under which the value will be stored.
- `value_type` (string, required) The data type of the claim value. One of: `string`, `email`, `phone`.
- `label` (string, required) The user-facing label displayed for this field during sign-up.

## Errors

- `400` Bad Request
  - `type` (string, required) A URI reference that identifies the error type. When accessed, it may provide human-readable documentation.
  - `title` (string, required) A short, human-readable summary of the error.
  - `status` (integer, required, int32) The HTTP status code associated with this error response.
  - `trace_id` (string, required) A unique identifier for the request, used for tracing and diagnostics.
  - `detail` (string) A human-readable explanation specific to this occurrence of the error.
  - `instance` (string) A URI reference that identifies the specific occurrence of the error.
- `401` Unauthorized
- `403` Forbidden
- `404` Not Found
  Same body as `400`.
- `422` Unprocessable Entity
  - `type` (string, required) A URI reference that identifies the error type. When accessed, it may provide human-readable documentation.
  - `title` (string, required) A short, human-readable summary of the error.
  - `status` (integer, required, int32) The HTTP status code associated with this error response.
  - `trace_id` (string, required) A unique identifier for the request, used for tracing and diagnostics.
  - `detail` (string) A human-readable explanation specific to this occurrence of the error.
  - `instance` (string) A URI reference that identifies the specific occurrence of the error.
  - `errors` (Record<string, string[]>, required) A key-value map of validation errors, where each key represents a request field and the value contains one or more messages describing why the request could not be processed.

## Example (MonoCloud .NET SDK)

```csharp
using MonoCloud.Management;
using MonoCloud.Management.Models;
using MonoCloud.Management.Core.Base;

var apiClient = new MonoCloudManagementClient(new MonoCloudConfig("<your-domain>", "[[API-Key]]"));


var claimName = "first_name";

var requestBody = new PatchSignUpCustomFieldRequest
  {
    Enabled = true,
    Required = false,
    ClaimName = "first_name",
    ValueType = ValueTypes.String,
    Label = "First Name",
  };


var result = await apiClient.Options.PatchSignUpCustomFieldAsync(claimName, requestBody);
```

## Example (MonoCloud Javascript SDK)

```javascript
import { MonoCloudManagementClient } from '@monocloud/management';

const apiClient = MonoCloudManagementClient.init({ domain: '<your-domain>', apiKey: '[[API-Key]]' });

const claimName = 'first_name';

const requestBody = {
  enabled: true,
  required: false,
  claim_name: 'first_name',
  value_type: 'string',
  label: 'First Name'
};

const result = apiClient.options.patchSignUpCustomField(claimName, requestBody);
```