Skip to main content
PATCH
/
v1
/
connections
/
{connectionId}
Update connection
curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseRole": "NO_ACCESS",
  "environmentUserAttribute": {
    "attributeName": "<string>",
    "defaultValues": [
      "<string>"
    ]
  }
}
'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
connectionId
string<uuid>
required

Connection ID

Body

application/json
​
baseRole
enum<string>

The default role for users accessing this connection

Available options:
NO_ACCESS,
VIEWER,
RESTRICTED_QUERIER,
QUERIER,
MODELER,
CONNECTION_ADMIN
​
environmentUserAttribute
object

Configuration for environment user attributes. Set to null to remove environment user attribute settings.

Response

Connection updated successfully

​
success
boolean
​
message
string