Activepieces Management Octri Preview
POST/v1/global-connections/{id}

Update a global connection

Updates a global connection's display name and optional project associations or metadata. Supply displayName and include only the additional connection properties you want to change.

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

1 parameter · 4 body fields
idstringrequired
The global connection identifier. Must contain exactly 21 alphanumeric characters.

Global connection properties to update.

displayNamestringrequired
The connection name to display. Must contain at least one character.
metadataobjectoptional
Key-value metadata to associate with the connection.
preSelectForNewProjectsbooleanoptional
Whether to preselect this connection for new projects.
projectIdsarray<string>optional
The project identifiers to associate with the connection.

1 status code
200Returns the updated global connection.

Error handling

The id path parameter must contain exactly 21 alphanumeric characters. displayName is required and must contain at least one character; projectIds, metadata, and preSelectForNewProjects can be included to update those properties.