Notifly
API ReferenceEnvironments

Update an environment

Update an environment by its unique identifier **environmentId**. You can modify the environment name, identifier, color, and other configuration settings.

PUT
/v1/environments/{environmentId}

Update an environment by its unique identifier environmentId. You can modify the environment name, identifier, color, and other configuration settings.

Authorization

secretKey
Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <secret_key>".

In: header

Path Parameters

environmentId*string

The unique identifier of the environment

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/environments/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "_id": "60d5ecb8b3b3a30015f3e1a1",    "name": "Production Environment",    "_organizationId": "60d5ecb8b3b3a30015f3e1a2",    "identifier": "prod-env-01",    "type": "prod",    "apiKeys": [      {        "key": "sk_test_1234567890abcdef",        "_userId": "60d5ecb8b3b3a30015f3e1a4",        "hash": "hash_value_here"      }    ],    "_parentId": "60d5ecb8b3b3a30015f3e1a3",    "slug": "production"  }}

Delete an environment DELETE

Delete an environment by its unique identifier **environmentId**. This action is irreversible and will remove the environment and all its associated data.

List environment tags GET

Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.