> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brudcast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a webhook endpoint

> Changes the URL, subscribed events, custom headers, retry settings or active flag of an endpoint. The updated endpoint is returned nested under `data.endpoint` rather than at `data`. Requires the `webhooks:write` scope.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/user/webhook-endpoints/{id}
openapi: 3.0.0
info:
  title: Brudcast API
  version: 1.0.0
servers:
  - url: https://core-service.prod.brudcast.com
    description: Production
security: []
tags:
  - name: Analytics
    x-displayName: Analytics
  - name: Campaigns
    x-displayName: Campaigns
  - name: Contacts
    x-displayName: Contacts
  - name: Mailboxes
    x-displayName: Mailboxes
  - name: Messages
    x-displayName: Messages
  - name: Sender Identities
    x-displayName: Sender Identities
  - name: Sending Domains
    x-displayName: Sending Domains
  - name: Templates
    x-displayName: Templates
  - name: Webhooks
    x-displayName: Webhooks
paths:
  /api/v1/user/webhook-endpoints/{id}:
    patch:
      tags:
        - Webhooks
      summary: Update a webhook endpoint
      description: >-
        Changes the URL, subscribed events, custom headers, retry settings or
        active flag of an endpoint. The updated endpoint is returned nested
        under `data.endpoint` rather than at `data`. Requires the
        `webhooks:write` scope.
      parameters:
        - in: header
          name: X-Organization-Id
          required: false
          description: >-
            Required when authenticating with an access token. Optional with an
            API key, whose own organization binding is authoritative; a value
            contradicting it is refused with 403.
          schema:
            type: string
            format: uuid
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  minLength: 2
                description:
                  type: string
                  nullable: true
                events:
                  type: array
                  items:
                    enum:
                      - email.delivered
                      - email.bounced
                      - email.opened
                      - email.clicked
                      - email.marked_spam
                      - email.unsubscribed
                      - email.dropped
                      - email.deferred
                      - email.rejected
                      - email.complained
                      - contact.subscribed
                      - contact.unsubscribed
                      - contact.updated
                      - campaign.sent
                      - campaign.completed
                      - test.event
                isActive:
                  type: boolean
                customHeaders:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                    required:
                      - key
                      - value
                    additionalProperties: false
                  nullable: true
                timeoutSeconds:
                  type: number
                  minimum: 0
                  maximum: 300
                maxRetries:
                  type: number
                  minimum: 0
                  maximum: 20
              additionalProperties: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointUpdateResultResponse'
        '401':
          description: The credential is missing, malformed, revoked or expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            The key lacks the scope the endpoint requires, or the organization
            does not match the credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such endpoint in the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The payload or query string failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '429':
          description: >-
            Rate limit exceeded; retry after the number of seconds in
            `retryAfter`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitErrorResponse'
      security:
        - apiKey: []
        - apiKeyBearer: []
components:
  schemas:
    WebhookEndpointUpdateResultResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        data:
          $ref: '#/components/schemas/WebhookEndpointUpdateResult'
      required:
        - success
        - message
        - data
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Resource not found
        code:
          type: string
          enum:
            - E_VALIDATION_ERROR
            - E_UNAUTHORIZED_ACCESS
            - E_UNAUTHORIZED
            - E_FORBIDDEN
            - E_INSUFFICIENT_SCOPE
            - E_ROW_NOT_FOUND
            - E_TOO_MANY_REQUESTS
            - E_BUSINESS_RULE_VIOLATION
            - E_CAMPAIGN_NOT_SENDABLE
            - INSUFFICIENT_CREDITS
            - SUBSCRIPTION_REQUIRED
          example: E_ROW_NOT_FOUND
      required:
        - success
        - message
        - code
    ValidationErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: The payload is invalid
        code:
          type: string
          enum:
            - E_VALIDATION_ERROR
            - E_UNAUTHORIZED_ACCESS
            - E_UNAUTHORIZED
            - E_FORBIDDEN
            - E_INSUFFICIENT_SCOPE
            - E_ROW_NOT_FOUND
            - E_TOO_MANY_REQUESTS
            - E_BUSINESS_RULE_VIOLATION
            - E_CAMPAIGN_NOT_SENDABLE
            - INSUFFICIENT_CREDITS
            - SUBSCRIPTION_REQUIRED
          example: E_VALIDATION_ERROR
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - success
        - message
        - code
        - errors
    RateLimitErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Too many requests
        code:
          type: string
          enum:
            - E_VALIDATION_ERROR
            - E_UNAUTHORIZED_ACCESS
            - E_UNAUTHORIZED
            - E_FORBIDDEN
            - E_INSUFFICIENT_SCOPE
            - E_ROW_NOT_FOUND
            - E_TOO_MANY_REQUESTS
            - E_BUSINESS_RULE_VIOLATION
            - E_CAMPAIGN_NOT_SENDABLE
            - INSUFFICIENT_CREDITS
            - SUBSCRIPTION_REQUIRED
          example: E_TOO_MANY_REQUESTS
        retryAfter:
          type: number
          example: 60
      required:
        - success
        - message
        - code
        - retryAfter
    WebhookEndpointUpdateResult:
      type: object
      properties:
        endpoint:
          $ref: '#/components/schemas/WebhookEndpoint'
      required:
        - endpoint
    ValidationErrorItem:
      type: object
      properties:
        field:
          type: string
          example: emailAddress
        rule:
          type: string
          example: email
        message:
          type: string
          example: The emailAddress field must be a valid email address
      required:
        - field
        - rule
        - message
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          format: uuid
        organizationId:
          type: string
          format: uuid
        url:
          type: string
          example: https://example.com/hooks/brudcast
        description:
          type: string
          nullable: true
        events:
          type: array
          items:
            type: string
            enum:
              - email.delivered
              - email.bounced
              - email.opened
              - email.clicked
              - email.marked_spam
              - email.unsubscribed
              - email.dropped
              - email.deferred
              - email.rejected
              - email.complained
              - contact.subscribed
              - contact.unsubscribed
              - contact.updated
              - campaign.sent
              - campaign.completed
              - test.event
          description: The event types the endpoint is subscribed to
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/WebhookCustomHeader'
          nullable: true
          description: Extra headers sent with every delivery to this endpoint
        isActive:
          type: boolean
        maxRetries:
          type: number
          description: Retries attempted after the first failed delivery
        timeoutSeconds:
          type: number
          description: Seconds to wait for the endpoint to respond
        lastTriggeredAt:
          type: string
          format: date-time
          nullable: true
          description: Null until the endpoint has received its first delivery
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - organizationId
        - url
        - description
        - events
        - isActive
        - maxRetries
        - customHeaders
        - timeoutSeconds
        - lastTriggeredAt
        - createdAt
        - updatedAt
    WebhookCustomHeader:
      type: object
      properties:
        key:
          type: string
          example: X-Signature-Source
        value:
          type: string
          example: brudcast
      required:
        - key
        - value
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        An organization API key, prefixed `bk_live_`. Takes precedence over
        `Authorization` when both are sent. The key is bound to one
        organization, and the scopes it was issued with are enforced per
        endpoint.
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: bk_live_...
      description: >-
        The same organization API key sent as `Authorization: Bearer
        bk_live_...`. Accepted only when the value begins with `bk_` and no
        `X-API-Key` header is present.

````