Update a sign-up custom field
Applies a partial update to the specified sign-up custom field configuration. Only fields included in the request are updated.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
The unique claim name identifying the custom field.
Request Body
application/json
The request payload used to update the field configuration.
TypeScript Definitions
Use the request body type in TypeScript.
Patch Sign-Up Custom Field Request: Used to update a sign-up custom field configuration.
Response Body
application/json
The sign-up custom field was updated successfully
TypeScript Definitions
Use the response body type in TypeScript.
Sign-up Custom Field Response: Represents the configuration of a custom field collected during user sign-up.
Errors
curl -X PATCH "https://your-domain.us.monocloud.com/api/options/authentication/signup/custom_fields/first_name" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{}'{ "enabled": true, "required": true, "claim_name": "string", "value_type": "string", "label": "string"}