POST /blueprintfields
Create a new blueprint field
/blueprintfieldsPOSTCreate a new blueprint field
| Key | Type | Example | Description |
|---|---|---|---|
| authorizationrequired | string | | Access token |
| Key | Type | Example | Description |
|---|---|---|---|
| blueprint_guidoptional | string | 'c45797061f2c15a75361042244385e96419d230ab804d7f...' | Associated blueprint GUID |
| default_valueoptional | string | | Default value for the field |
| descriptionoptional | string | | Field description |
| metadataoptional | object | | Additional metadata for the field |
| namerequired | string | | Field name |
| requiredoptional | boolean | | Whether this field is required |
| typerequired | string | | Field data type Allowed: "string", "number", "boolean", "object", "array", "date" |
| validation_rulesoptional | object | {} | Validation rules for the field |
{
"_meta": {
"created": 1782166695,
"entity": 1,
"guid": "a23575f49d0af385314c1f02280163374297e018a692e5e4ab85eb307ebf6ebc",
"modified": 1782166695,
"updated": 1782166695
},
"blueprint_guid": "c45797061f2c15a75361042244385e96419d230ab804d7fa08cd52981fd78192",
"default_value": "enabled",
"description": "User's email address",
"metadata": {
"placeholder": "Enter your email",
"ui_component": "text-input"
},
"name": "user_email",
"required": false,
"type": "string",
"validation_rules": {
"max_length": 100,
"min_length": 5,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
}
}{
"code": 401,
"error": "INVALID_ACCESS_TOKEN"
}| 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