Activepieces Management Octri Preview
POST/v1/projects/{id}

Update a project

Updates the configuration of an existing project. Supply only the fields you want to change; displayName must not contain a period or slash, and maxConcurrentJobs, when set, must be a positive integer.

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

1 parameter · 8 body fields
idstringrequired
The unique identifier of the project to update.

Project configuration fields to update; all fields are optional.

displayNamestringoptional
The project display name. Must not contain a period or slash.
externalIdstringoptional
An external identifier for the project.
globalConnectionExternalIdsarray<string>optional
External identifiers of global connections to associate with the project.
iconobjectoptional
Project icon configuration. The `color` field must be one of the listed color values.
maxConcurrentJobsintegeroptional
The maximum number of concurrent jobs. Must be a positive integer no greater than 9007199254740991, or null.
metadataobjectoptional
Additional project metadata, with string property names.
planobjectoptional
Plan settings, including the allowed piece identifiers and piece filter type. `piecesFilterType` must be `NONE` or `ALLOWED`.
releasesEnabledbooleanoptional
Whether releases are enabled for the project.

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

Error handling

The id path parameter must identify the project to update. If supplied, displayName must not contain a period or slash, icon.color must be one of the listed color values, plan.piecesFilterType must be NONE or ALLOWED, and maxConcurrentJobs must be a positive integer no greater than 9007199254740991.