Connections

Update Connection Tags

Update the tags on a connection. Tags are free-form labels you can use to organize and filter connections.

patch/v1/connections/{id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/connections/{id}
  • Auth: one of:
    • API key in header X-One-Secret
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:connections:write)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:connections:write)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: project:connections:write)

Path parameters

idstring uuid required

Connection ID

Headers

X-One-Organization-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

X-One-Project-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

Request body

namestring nullable

New display name for the connection. Empty string clears it; when omitted, the name is left untouched.

tagsstring[] nullable

New tag set for the connection, checked by the shared tag check in the handler. When omitted, tags are left untouched.

Response

Connection tags updated

Changes

No recorded changes to this operation across all 1 revision of this API.