Update an integration connection's label and/or shared_with_org flag
The connection owner or a holder of integrations:configure may edit it. Sharing (shared_with_org: true) is the owner's consent and is refused with 403 to anyone else; unsharing is open to both, so a governor can withdraw a colleague's shared credentials. Sharing an end user's connection is refused with 409 end_user_connection_not_shareable. Unsharing (shared_with_org: false) is refused with 409 connection_pinned while an admin pin or an org default (enforced or soft) names the connection. A member pin does not block it: that member's next run fails with pinned_connection_unavailable until they pick again. Unsharing a shared connection disables, in the same transaction, every enabled schedule of another actor than its owner whose connection_overrides name it (disabled_reason: connection_unshared, jobs removed), its overrides kept: while the connection stays unreachable, re-enabling it requires a new choice. The owner's own schedules are untouched. A label is unique per (space, integration), compared verbatim: renaming to one another connection holds is refused with 409 connection_label_taken.
/api/integrations/{packageId}/connections/{connectionId}Cookie session from Better Auth. Requires X-Org-Id header for org-scoped routes.
In: cookie
Path Parameters
Integration package id (e.g. @official/gmail).
^@[a-z0-9][a-z0-9-]*/[a-z0-9][a-z0-9-]*$Integration connection id (UUID).
uuidHeader Parameters
Organization ID. Required for cookie auth. Not needed for API key auth (org resolved from key).
uuidSpace ID. Required for space-scoped routes (agents, runs, schedules, and space-scoped module routes). Not needed for API key auth (space resolved from key).
Request Body
application/json
curl -X PATCH "https://your-instance/api/integrations/string/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"integration_package_id": "string",
"auth_key": "string",
"account_id": "string",
"identity_claims": {},
"scopes_granted": [
"string"
],
"needs_reconnection": true,
"expiresAt": "2019-08-24T14:15:22Z",
"owner_type": "user",
"owner_id": "string",
"owner_name": "string",
"locked_by": "admin_pin",
"label": "string",
"shared_with_org": true,
"client_ref": "string",
"variables": {
"property1": "string",
"property2": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"type": "https://docs.appstrate.dev/errors/validation-failed",
"title": "Validation Failed",
"status": 400,
"detail": "name: Invalid input: expected string, received undefined (+2 more)",
"code": "validation_failed",
"request_id": "req_abc123",
"errors": [
{
"field": "name",
"code": "required",
"message": "Invalid input: expected string, received undefined"
},
{
"field": "email",
"code": "invalid_format",
"message": "Invalid email address"
},
{
"field": "age",
"code": "invalid_type",
"message": "Invalid input: expected number, received string"
}
]
}{
"type": "https://docs.appstrate.dev/errors/forbidden",
"title": "Forbidden",
"status": 403,
"detail": "Insufficient permissions",
"code": "forbidden",
"request_id": "req_abc123"
}{
"type": "https://docs.appstrate.dev/errors/not-found",
"title": "Not Found",
"status": 404,
"detail": "Resource not found",
"code": "not_found",
"request_id": "req_abc123"
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"code": "string",
"request_id": "string",
"param": "string",
"retry_after": 0,
"errors": [
{
"field": "string",
"code": "string",
"message": "string",
"title": "string",
"candidate_connections": [
{
"id": "string",
"label": "string",
"account_id": "string",
"owned_by_actor": true,
"needs_reconnection": true
}
],
"connection_id": "string",
"missing_scopes": [
"string"
],
"owned_by_actor": true,
"required_scopes": [
"string"
],
"auth_key": "string",
"required_auth_key": "string",
"available_auth_keys": [
"string"
],
"connect_url": "http://example.com",
"expiresAt": "2019-08-24T14:15:22Z",
"packageId": "string"
}
]
}