---
title: "Update Subscription"
method: PATCH
path: "/api/v1/webhooks/subscriptions/{sub_id}"
tags: ["Webhooks"]
---

# Update Subscription

`PATCH /api/v1/webhooks/subscriptions/{sub_id}`

## Path parameters

- `sub_id` string, uuid, required

## Request body

- WebhookSubscriptionUpdateRequest
  - `url` string, nullable
  - `event_types` union[], nullable
    - union
      - 'message.received' | 'message.sent' | 'message.forwarded' | 'message.delivered' | 'message.bounced' | 'message.failed'
      - 'text.received' | 'text.sent' | 'text.delivered' | 'text.delivery_failed' | 'text.delivery_unconfirmed'
      - 'call.ended'
      - 'imessage.received' | 'imessage.reaction_received' | 'imessage.sent' | 'imessage.delivered' | 'imessage.delivery_failed'
      - 'a2a.task.created' | 'a2a.task.message' | 'a2a.task.canceled' | 'a2a.sent_task.updated'
  - `context_config` WebhookContextConfig
    - `email` union
      - WebhookContextCountConfig
        - `mode` 'count', required
        - `count` integer, required
      - WebhookContextWindowConfig
        - `mode` 'window', required
        - `hours` integer, required
    - `texts` union
      - WebhookContextCountConfig
        - `mode` 'count', required
        - `count` integer, required
      - WebhookContextWindowConfig
        - `mode` 'window', required
        - `hours` integer, required
    - `calls` union
      - WebhookContextCountConfig
        - `mode` 'count', required
        - `count` integer, required
      - WebhookContextWindowConfig
        - `mode` 'window', required
        - `hours` integer, required
  - `auth_token` string, nullable

## Response `200`

Successful Response

- WebhookSubscriptionResponse
  - `id` string, uuid, required
  - `organization_id` string, required
  - `mailbox_id` string, uuid, nullable, required
  - `phone_number_id` string, uuid, nullable, required
  - `agent_identity_id` string, uuid, nullable
  - `owner_identity_id` string, uuid, nullable
  - `url` string, required
  - `event_types` union[], required
    - union
      - 'message.received' | 'message.sent' | 'message.forwarded' | 'message.delivered' | 'message.bounced' | 'message.failed'
      - 'text.received' | 'text.sent' | 'text.delivered' | 'text.delivery_failed' | 'text.delivery_unconfirmed'
      - 'call.ended'
      - 'imessage.received' | 'imessage.reaction_received' | 'imessage.sent' | 'imessage.delivered' | 'imessage.delivery_failed'
      - 'a2a.task.created' | 'a2a.task.message' | 'a2a.task.canceled' | 'a2a.sent_task.updated'
  - `context_config` WebhookContextConfig
    - `email` union
      - WebhookContextCountConfig
        - `mode` 'count', required
        - `count` integer, required
      - WebhookContextWindowConfig
        - `mode` 'window', required
        - `hours` integer, required
    - `texts` union
      - WebhookContextCountConfig
        - `mode` 'count', required
        - `count` integer, required
      - WebhookContextWindowConfig
        - `mode` 'window', required
        - `hours` integer, required
    - `calls` union
      - WebhookContextCountConfig
        - `mode` 'count', required
        - `count` integer, required
      - WebhookContextWindowConfig
        - `mode` 'window', required
        - `hours` integer, required
  - `auth_token` string, nullable
  - `has_auth_token` boolean
  - `status` 'active' | 'deleted', required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error
- `4XX` — Client error with Support Agent information.
- `5XX` — Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) · [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inkbox/inkbox-api/revisions/31f357e7e6f8/schema)