---
title: "Request to update a subscription"
method: POST
path: "/v1/externalevents/requests/update"
tags: ["Edit Subscriptions", "Requests"]
---

# Request to update a subscription

`POST /v1/externalevents/requests/update`

## Request body

- object
  - `id` string, required
  - `update` EventbridgeSubscriptionUpdate, required
    - `selectedEventTypes` string[] — The types of events to subscribe to
    - `userDefinedName` string — Subscription name set and displayed in the UI
    - `targetEndpoint` string — Amazon Resource Name of the bus resource where events should be sent
    - `targetType` 'BUS'
    - `enabled` boolean

## Response `200`

Request created successfully

- union
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required — The types of events to subscribe to
      - `userDefinedName` string, required — Subscription name set and displayed in the UI
      - `targetEndpoint` string, required — Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'queued', required
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required — The types of events to subscribe to
      - `userDefinedName` string, required — Subscription name set and displayed in the UI
      - `targetEndpoint` string, required — Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'in-progress', required
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required — The types of events to subscribe to
      - `userDefinedName` string, required — Subscription name set and displayed in the UI
      - `targetEndpoint` string, required — Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'failed', required
    - `output` object, required
      - `message` string, required
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required — The types of events to subscribe to
      - `userDefinedName` string, required — Subscription name set and displayed in the UI
      - `targetEndpoint` string, required — Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'completed', required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[] — The types of events to subscribe to
        - `userDefinedName` string — Subscription name set and displayed in the UI
        - `targetEndpoint` string — Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'queued', required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[] — The types of events to subscribe to
        - `userDefinedName` string — Subscription name set and displayed in the UI
        - `targetEndpoint` string — Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'in-progress', required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[] — The types of events to subscribe to
        - `userDefinedName` string — Subscription name set and displayed in the UI
        - `targetEndpoint` string — Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'failed', required
    - `output` object, required
      - `message` string, required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[] — The types of events to subscribe to
        - `userDefinedName` string — Subscription name set and displayed in the UI
        - `targetEndpoint` string — Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'completed', required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'queued', required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'in-progress', required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'failed', required
    - `output` object, required
      - `message` string, required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'completed', required

## Other responses

- `400` — Incorrect input provided
- `404` — Not found or not visible to user
- `500` — Internal error managing rules on eventbridge
- `501` — Internal error managing rules on eventbridge

---

[API](https://skmtc.net/tetrascience/apis/tetra-data-lake.md) · [All operations](https://skmtc.net/tetrascience/apis/tetra-data-lake/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tetrascience/tetra-data-lake/versions/0205e2bace53/schema)