Create Custom Attribute
This endpoint creates a new attribute for a specified target (collection or list).
Description
This API endpoint allows the creation of a new attribute within a specified target, either a collection or a list. Attributes define the nature and characteristics of the data stored within the target.
Path
Specifies the target type, which can be either “collection” or “list.”
A unique identifier for the target, either a collection ID or a list ID, depending on the target type.
Body
The API key name used to store data in the collection or list for this field.
Defines the input type or nature of the field. Possible values include text, number, checkbox, currency, date, timestamp, rating, status, select, multiselect, record-reference, actor-reference, domain, file, ai-wizard, email-address, phone-number.
The human-readable name of the field.
Configuration settings for the attribute, including currency display type, currency code, record reference, AI wizard, and date display type.
The default value for the attribute.
A description providing additional information about the attribute.
Indicates whether the attribute is editable (true/false).
Indicates whether the attribute supports multiple selections (true/false).
Indicates whether the attribute is required (true/false).
Indicates whether the attribute values must be unique (true/false).
The validation type for the attribute. Possible values include “none,” “email,” “url,” “phone,” “customRegex.”
Response
Indicates the success or failure of the attribute creation. In this case, true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance, it confirms the successful creation of the attribute.
An object containing details of the newly created attribute: