Update connection environment

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/connection-environments/{connectionEnvironmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userAttributeValues": "<string>"
}
'

{
  "success": true
}

Connection environments

Update connection environment

Associates user attribute values with a specific connection environment. These user attribute values determine when the environment connection will be used.

Note: User attribute values for environment connections work in conjunction with the user attribute name and values set on the base connection, which can be defined using the Update a connection endpoint. The base connection specifies which user attribute to evaluate, while each environment connection specifies which values of that attribute will trigger its use.

PUT

connection-environments

{connectionEnvironmentId}

Update connection environment

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/connection-environments/{connectionEnvironmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userAttributeValues": "<string>"
}
'

{
  "success": true
}

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

connectionEnvironmentId

string<uuid>

required

The ID of the connection environment to update

Body

application/json

userAttributeValues

string

A comma-separated list of user attribute values to associate with the connection environment. For example: "dev,staging"

Note: User attribute values must be unique across all environments for a base connection.

Response

Connection environment updated successfully

success

boolean

Example:

true

Create connection environments

List connections

Resources

Guides

Update connection environment

Authorizations

Path Parameters

Body

Response