POST/v1/app-connections/{id}

Update an app connection

Updates an app connection's display name and metadata. Supply displayName; you can also include metadata to update its associated key-value data.

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

1 parameter · 2 body fields
idstringrequired
The app connection identifier, exactly 21 alphanumeric characters.

App connection fields to update. displayName is required; metadata is optional.

displayNamestringrequired
The app connection's display name. Must contain at least one character.
metadataobjectoptional
Key-value metadata for the app connection, with string property names.

1 status code
200Returns the updated app connection.

Error handling

The body must include displayName, which must contain at least one character. The id path parameter must contain exactly 21 alphanumeric characters and identify the app connection to update.