Update notification channel

curl --request PATCH \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "event_types": ["job.completed", "job.failed", "job.in_progress"],
    "enabled": true
  }'

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.notifications.update_channel(
    request=UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest(
        channel_id="c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
        event_types=["job.completed", "job.failed", "job.in_progress"],
        enabled=True,
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest

async def update_channel():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.notifications.update_channel_async(
        request=UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest(
            channel_id="c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
            event_types=["job.completed", "job.failed", "job.in_progress"],
            enabled=True,
        )
    )
    print(response)

asyncio.run(update_channel())

{
  "id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "channel_type": "webhook",
  "description": "Job status alerts",
  "event_types": ["job.completed", "job.failed", "job.in_progress"],
  "enabled": true,
  "url": "https://hooks.example.com/notify",
  "created_at": "2026-04-29T10:00:00Z",
  "updated_at": "2026-04-29T11:00:00Z"
}

PATCH

api

notifications

channels

{channel_id}

curl --request PATCH \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "event_types": ["job.completed", "job.failed", "job.in_progress"],
    "enabled": true
  }'

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.notifications.update_channel(
    request=UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest(
        channel_id="c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
        event_types=["job.completed", "job.failed", "job.in_progress"],
        enabled=True,
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest

async def update_channel():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.notifications.update_channel_async(
        request=UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest(
            channel_id="c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
            event_types=["job.completed", "job.failed", "job.in_progress"],
            enabled=True,
        )
    )
    print(response)

asyncio.run(update_channel())

{
  "id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "channel_type": "webhook",
  "description": "Job status alerts",
  "event_types": ["job.completed", "job.failed", "job.in_progress"],
  "enabled": true,
  "url": "https://hooks.example.com/notify",
  "created_at": "2026-04-29T10:00:00Z",
  "updated_at": "2026-04-29T11:00:00Z"
}

Channels that have not been verified cannot be updated.

Path parameters

string

required

The unique identifier of the notification channel to update.

Body

string

Updated channel description. Maximum 255 characters.

array

Updated list of event types to subscribe to.

Value	Description
`job.scheduled`	Job queued to run
`job.in_progress`	Job has started
`job.completed`	Job finished processing
`job.stopped`	Job has stopped
`job.failed`	Job failed to initialize without processing any files

boolean

Whether the channel is active.

string

Updated webhook endpoint URL. Applies when channel_type is webhook.

string

Updated signing secret for verifying incoming webhook requests. Must be between 24 and 75 bytes (24 to 75 ASCII characters). Applies when channel_type is webhook. Omit to keep the current value.Use this secret to verify incoming webhook requests. If you do not provide a secret, you cannot use secret-based verification for incoming webhook requests.

object

Updated email delivery configuration. Applies when channel_type is email.

Value	Required	Description
`recipient_email`	yes	Email address to deliver notifications to.
`reply_to`		Email address set as the reply-to header in notification emails.
`cc`		Additional email addresses to copy on notification emails. Array of strings.

Response

string

required

Unique identifier for the channel.

string

required

Channel type: webhook or email.

array

required

Subscribed event types.

boolean

required

Whether the channel is active.

string

required

ISO 8601 timestamp when the channel was created.

string

required

ISO 8601 timestamp when the channel was last updated.

string

Channel description.

string

Webhook endpoint URL. Present when channel_type is webhook.

object

Email delivery configuration. Present when channel_type is email.

curl --request PATCH \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "event_types": ["job.completed", "job.failed", "job.in_progress"],
    "enabled": true
  }'

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.notifications.update_channel(
    request=UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest(
        channel_id="c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
        event_types=["job.completed", "job.failed", "job.in_progress"],
        enabled=True,
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest

async def update_channel():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.notifications.update_channel_async(
        request=UpdateChannelApiV1NotificationsChannelsChannelIdPatchRequest(
            channel_id="c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
            event_types=["job.completed", "job.failed", "job.in_progress"],
            enabled=True,
        )
    )
    print(response)

asyncio.run(update_channel())

{
  "id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  "channel_type": "webhook",
  "description": "Job status alerts",
  "event_types": ["job.completed", "job.failed", "job.in_progress"],
  "enabled": true,
  "url": "https://hooks.example.com/notify",
  "created_at": "2026-04-29T10:00:00Z",
  "updated_at": "2026-04-29T11:00:00Z"
}

⌘I

Unstructured API

Workflow Operations

API Reference

Legacy APIs

Troubleshooting

Update notification channel

Path parameters

Body

Response

​Path parameters

​Body

​Response

Path parameters

Body

Response