POST /blueprints

Create a new blueprint with auto-generated short_id and change tracking

Create a new blueprint with auto-generated short_id and change tracking
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
KeyTypeExampleDescription
categoryoptionalstring
"example"
Blueprint category
descriptionoptionalstring
"Used by the nightly order sync."
Blueprint description
nameoptionalstring
"production"
Blueprint name
tagsoptionalarray
["example"]
Blueprint tags
{
  "_meta": {
    "created": 1782166695,
    "entity": 1,
    "guid": "a23575f49d0af385314c1f02280163374297e018a692e5e4ab85eb307ebf6ebc",
    "modified": 1782166695,
    "updated": 1782166695
  },
  "actions": [
    {}
  ],
  "category": "authentication",
  "created_by_user_guid": "a23575f49d0af385314c1f02280163374297e018a692e5e4ab85eb307ebf6ebc",
  "description": "Automates user registration with email verification and profile setup",
  "is_published": false,
  "last_modified_by_user_guid": "a23575f49d0af385314c1f02280163374297e018a692e5e4ab85eb307ebf6ebc",
  "name": "User Registration Workflow",
  "permissions": {
    "edit": [
      "example"
    ],
    "execute": [
      "example"
    ],
    "view": [
      "example"
    ]
  },
  "settings": {
    "auto_retry": false,
    "max_retries": 3,
    "parallel_execution": false,
    "timeout": 300000
  },
  "short_id": "TpQ8K3mN9xVz",
  "statistics": {
    "average_duration": 12.5,
    "failed_executions": 0,
    "last_execution": 1782166695,
    "successful_executions": 0,
    "total_executions": 0
  }
}
{
  "code": 401,
  "error": "INVALID_ACCESS_TOKEN"
}
StatusError CodeDescription
401INVALID_ACCESS_TOKENAuthentication required or invalid token
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
blueprints_createRequired scope: blueprints_create

Back to Blueprints Return to the Blueprints category to view other endpoints All API Categories Browse all available API categories