Create a sign-up custom field
Creates a new custom field to be collected during user sign-up.
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>
Request Body
application/json
The request payload used to create a sign-up custom field configuration.
TypeScript Definitions
Use the request body type in TypeScript.
Create Sign-Up Custom Field Request: Creates a configuration for a custom field collected during user sign-up.
Response Headers
201
Returns the location header
uriResponse Body
application/json
The sign-up custom field was created 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 POST "https://your-domain.us.monocloud.com/api/options/authentication/signup/custom_fields" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{ "enabled": true, "required": true, "claim_name": "string", "value_type": "string", "label": "string" }'{ "enabled": true, "required": true, "claim_name": "string", "value_type": "string", "label": "string"}