POST /blueprints
Create a new blueprint with auto-generated short_id and change tracking
/blueprints
POST
Create a new blueprint with auto-generated short_id and change tracking
| Key | Type | Example | |
|---|---|---|---|
| authorization required | string |
"Bearer your-jwt-token"
|
| Key | Type | Example | Description |
|---|---|---|---|
| name optional | string |
"example-string"
|
Blueprint name
|
| description optional | string |
"example-string"
|
Blueprint description
|
| category optional | string |
"example-string"
|
Blueprint category
|
| tags optional | array |
[]
|
Blueprint tags
|
{
"_meta": {
"guid": "example-string",
"entity": "example-value",
"created": "example-value",
"modified": "example-value",
"updated": "example-value"
},
"name": "User Registration Workflow",
"description": "Automates user registration with email verification and profile setup",
"short_id": "TpQ8K3mN9xVz",
"category": "authentication",
"tags": [
"user-management",
"automation",
"email"
],
"status": "draft",
"version": "1.2.3",
"is_published": false,
"created_by_user_guid": "example-string",
"last_modified_by_user_guid": "example-string",
"actions": [
{
"_meta": {
"guid": "example-string",
"entity": "example-value",
"created": "example-value",
"modified": "example-value",
"updated": "example-value"
},
"type": "http_request",
"blueprint_guid": "example-string",
"position": {
"x": 150,
"y": 300
},
"event": "/api/users",
"fields": [
"example-string"
],
"default_value": "example-value",
"value": "example-value",
"in_pins": [
{}
],
"out_pins": [
{}
],
"custom_out_pins": [
{}
],
"scopes": [
"example-string"
],
"storages": [
"example-string"
],
"is_public": true,
"custom_header_text": "example-string",
"is_created": true,
"modified_user": "example-string",
"unsaved": "example-value"
}
],
"variables": {},
"settings": {
"auto_retry": false,
"max_retries": 3,
"timeout": 300000,
"parallel_execution": false
},
"statistics": {
"total_executions": 0,
"successful_executions": 0,
"failed_executions": 0,
"average_duration": 123,
"last_execution": "example-value"
},
"permissions": {
"view": [
"example-string"
],
"edit": [
"example-string"
],
"execute": [
"example-string"
]
}
}
{
"success": false,
"error": "HTTP_401",
"message": "Error response"
}
| Error Code | Description |
|---|---|
| HTTP_401 | HTTP 401 error |
| permission | description |
|---|---|
BearerAuth |
JWT access token obtained from login endpoint required |
Back to Blueprints Return to the Blueprints category to view other endpoints All API Categories Browse all available API categories