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": "CONNECTION_ADMIN",
  "environmentUserAttribute": {}
}
'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use 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>

Base role for connection access

Available options:
CONNECTION_ADMIN,
QUERIER
​
environmentUserAttribute
object

Environment user attribute configuration

Response

Connection updated successfully

​
success
boolean
​
message
string