Update an Alert Notification Channel | Astronomer Documentation

curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels/notificationChannelId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "createdAt": "2024-06-01T10:15:30Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deployment-service-key",
    "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "jane.doe@astronomer.io"
  },
  "definition": null,
  "entityId": "ent_0987654321fedcba",
  "entityType": "DEPLOYMENT",
  "id": "nc_abcdef1234567890",
  "isShared": true,
  "name": "Critical Alerts Channel",
  "organizationId": "org_1234abcd5678efgh",
  "type": "EMAIL",
  "updatedAt": "2024-06-01T12:00:00Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deployment-service-key",
    "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "jane.doe@astronomer.io"
  },
  "deploymentId": "dep_1234567890abcdef",
  "entityName": "Data Pipeline Deployment",
  "workspaceId": "ws_5678efgh1234abcd"
}

Update an Alert Notification Channel.

curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels/notificationChannelId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "createdAt": "2024-06-01T10:15:30Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deployment-service-key",
    "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "jane.doe@astronomer.io"
  },
  "definition": null,
  "entityId": "ent_0987654321fedcba",
  "entityType": "DEPLOYMENT",
  "id": "nc_abcdef1234567890",
  "isShared": true,
  "name": "Critical Alerts Channel",
  "organizationId": "org_1234abcd5678efgh",
  "type": "EMAIL",
  "updatedAt": "2024-06-01T12:00:00Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "deployment-service-key",
    "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "jane.doe@astronomer.io"
  },
  "deploymentId": "dep_1234567890abcdef",
  "entityName": "Data Pipeline Deployment",
  "workspaceId": "ws_5678efgh1234abcd"
}

Update an Alert Notification Channel.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the Notification Channel belongs.

notificationChannelIdstringRequired

The ID of the Notification Channel to update.

Request

The request body for updating a Notification Channel.

Response

createdAtstringformat: "date-time"

The time when the alert was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject

definitionany

The notification channel's definition.

entityIdstring

The entity ID the notification channel is scoped to.

entityTypestring

The type of entity the notification channel is scoped to.

idstring

The notification channel's ID.

isSharedboolean

When entity type is scoped to ORGANIZATION or WORKSPACE, this determines if child entities can access this notification channel.

namestring

The notification channel's name.

organizationIdstring

The organization ID the notification channel is scoped to.

typestring

The notification channel's type.

updatedAtstringformat: "date-time"

The time when the alert was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedByobject

deploymentIdstring

The deployment ID the notification channel is scoped to.

entityNamestring

The name of the entity the notification channel is scoped to.

workspaceIdstring

The workspace ID the notification channel is scoped to.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels/notificationChannelId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"createdAt": "2024-06-01T10:15:30Z",
3	"createdBy": {
4	"id": "clm8qv74h000008mlf08scq7k",
5	"apiTokenName": "deployment-service-key",
6	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
7	"fullName": "Jane Doe",
8	"subjectType": "USER",
9	"username": "jane.doe@astronomer.io"
10	},
11	"definition": null,
12	"entityId": "ent_0987654321fedcba",
13	"entityType": "DEPLOYMENT",
14	"id": "nc_abcdef1234567890",
15	"isShared": true,
16	"name": "Critical Alerts Channel",
17	"organizationId": "org_1234abcd5678efgh",
18	"type": "EMAIL",
19	"updatedAt": "2024-06-01T12:00:00Z",
20	"updatedBy": {
21	"id": "clm8qv74h000008mlf08scq7k",
22	"apiTokenName": "deployment-service-key",
23	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
24	"fullName": "Jane Doe",
25	"subjectType": "USER",
26	"username": "jane.doe@astronomer.io"
27	},
28	"deploymentId": "dep_1234567890abcdef",
29	"entityName": "Data Pipeline Deployment",
30	"workspaceId": "ws_5678efgh1234abcd"
31	}