API Reference
Privacy & SecuritySupport CenterLog In

Create Custom Attribute

post
https://api.regal.ai/v1/custom-attributes

API Details

Creates a custom attribute in the brand. The name is unique within the brand, and the name and the data type cannot be changed afterwards. A brand can have at most 10 custom attributes.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Body Params
string
required
length between 1 and 255
^[a-zA-Z0-9_]+$

Name of the custom attribute: up to 255 letters, digits and underscores. It is unique within the brand and cannot be changed after the attribute is created.

string
enum
required

Type of the values of the attribute. It cannot be changed after the attribute is created.

Allowed:
string | null

Description of the custom attribute. Omit it, or send null, for an attribute with no description.

Responses

400

Invalid body.

403

The user is not a brand admin.

Updated about 11 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?