Activepieces Management Octri Preview
POST/v1/projects

Create a project

Creates a project with the supplied display name and optional configuration. The required displayName must not contain a period or slash; provide alertReceiverEmail in a valid email format when setting it.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Project configuration. displayName is required; the other fields are optional.

alertReceiverEmailstringoptional
An email address for project alerts, or null.
displayNamestringrequired
The project display name. Must not contain a period or slash.
externalIdstringoptional
An external identifier for the project, or null.
globalConnectionExternalIdsarray<string>optional
External identifiers of global connections to associate with the project.
maxConcurrentJobsnumberoptional
The maximum number of concurrent jobs, or null.
metadataobjectoptional
Additional project metadata, or null.

1 status code
201Returns the created project, including its identifier, display name, project type, plan, and analytics.
analyticsobjectrequired
createdstringrequired
displayNamestringrequired
externalIdstringoptional
iconobjectrequired
idstringrequired
maxConcurrentJobsnumberoptional
metadataobjectoptional
ownerIdstringrequired
planobjectrequired
platformIdstringrequired
poolIdstringoptional
releasesEnabledbooleanrequired
typestringrequired
Allowed:TEAMPERSONAL
updatedstringrequired

Error handling

displayName is required and must not contain a period or slash. If supplied and not null, alertReceiverEmail must be a valid email address.