For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd one or more components to project
        • POSTCreate a new component group document
        • POSTCreate a new project
        • POSTCreate a new template document
        • POSTCreate a new workflow document
        • DELDelete a component group document
        • DELDelete a project and any components it contains
        • DELDelete a template document
        • POSTDiscover referenced resources
        • GETExport a template document
        • GETExport project as JSON document
        • GETGet a list of all the apps and adapters
        • GETGet a page of component group documents
        • GETGet a page of template documents
        • GETGet a page of workflow documents
        • GETGet a project's thumbnail
        • GETGet component group document
        • GETGet details of a workflow
        • GETGet project
        • GETGet references to a particular document
        • GETGet task details
        • POSTGet task details
        • GETGet template document
        • POSTImport a new component group document
        • POSTImport a new template document
        • POSTImport a new workflow document
        • POSTImport a project document from a JSON document
        • GETList all available rest calls
        • DELRemove a component from a project
        • PUTReplace a component group document
        • PUTReplace a template document
        • PUTReplace a workflow document
        • GETSearch projects
        • PUTSet a project's thumbnail image
        • PATCHUpdate an existing project
        • POSTValidate a workflow
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAutomation Studio

Update an existing project

PATCH
http://localhost:3000/automation-studio/projects/:projectId
PATCH
/automation-studio/projects/:projectId
$curl -X PATCH http://localhost:3000/automation-studio/projects/62a1f3d2ebedfc54e6e0065c \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "message": "string",
3  "data": null,
4  "metadata": {}
5}
Updates an existing project.
Was this page helpful?
Previous

Validate a workflow

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

projectIdstring or integerRequired
Project identifier, either an ObjectId or an IID

Request

updateData
namestringOptional
Project name
descriptionstringOptional

A free-form block of text for describing project intent and function

thumbnailBackgroundColorstringOptionalDefaults to #FFFFFF
Thumbnail background color
memberslist of objectsOptional
versionobjectOptional
gitConfigurationobjectOptional

Response

Update result
messagestring
dataobject or null
Project data as it is sent back from get and search endpoints
metadataobject

Errors

500
Internal Server Error