POST /blueprintfields
Create a new blueprint field
/blueprintfields
POST
Create a new blueprint field
| Key | Type | Example | Description |
|---|---|---|---|
| authorization required | string |
"Bearer access_token"
|
Access token
|
| Key | Type | Example | Description |
|---|---|---|---|
| name required | string |
"user_email"
|
Field name
|
| type required | string |
"string"
|
Field data type
Allowed:
string, number, boolean, object, array, date |
| description optional | string |
"User's email address"
|
Field description
|
| blueprint_guid optional | string |
"example-string"
|
Associated blueprint GUID
|
| required optional | boolean |
false
|
Whether this field is required
|
| default_value optional | string |
"example-value"
|
Default value for the field
|
| validation_rules optional | object |
{}
|
Validation rules for the field
|
| metadata optional | object |
{}
|
Additional metadata for the field
|
{
"_meta": {
"guid": "example-string",
"entity": 42,
"created": 42,
"modified": 42,
"updated": 42
},
"name": "user_email",
"type": "string",
"description": "User's email address",
"blueprint_guid": "example-string",
"required": false,
"default_value": "example-value",
"validation_rules": {
"min_length": 5,
"max_length": 100,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
},
"metadata": {
"ui_component": "text-input",
"placeholder": "Enter your email"
}
}
{
"error": "INVALID_ACCESS_TOKEN",
"code": 401
}
| Status | Error Code | Description |
|---|---|---|
401 |
INVALID_ACCESS_TOKEN |
Authentication required or invalid token |
| Permission | Description |
|---|---|
Bearer token |
Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
blueprintfields_create |
Required scope: blueprintfields_create |
Back to Blueprint Fields Return to the Blueprint Fields category to view other endpoints All API Categories Browse all available API categories