---
title: "Update Endpoint"
method: PUT
path: "/endpoint/{endpoint_id}"
tags: ["Endpoint"]
---

# Update Endpoint

`PUT /endpoint/{endpoint_id}`

## Request

- Base URL: `https://api.sinay.ai/webhook/api/v1`
- URL: `https://api.sinay.ai/webhook/api/v1/endpoint/{endpoint_id}`
- Auth: API key in header `API_KEY`

Update an endpoint. This will replace all your endpoint parameters with the one you specify. If you don't specify a parameter, it will be erased. If you wish to update an endpoint partially, use PATCH /endpoint/{endpoint_id}

## Path parameters

- `endpoint_id` string, required: The ep's ID or UID

## Request body

- EndpointUpdate
  - `description` string: Description of your endpoint
  - `rateLimit` integer, nullable: Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.
  - `uid` string, nullable: Optional unique identifier for the endpoint
  - `url` string, uri, required: Public url in your services where you plan to receive our webhooks.
  - `disabled` boolean: When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.
  - `filterTypes` string[], nullable
  - `channels` string[], nullable: List of message channels this endpoint listens to (omit for all)
  - `metadata` object: Optional additional properties for your endpoint.

## Response `200`

- EndpointOut
  - `id` string, required: The ep's ID
  - `metadata` object, required: Optional additional properties for your endpoint.
  - `description` string, required: An example endpoint name
  - `rateLimit` integer, nullable: Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.
  - `uid` string, nullable: Optional unique identifier for the endpoint
  - `url` string, uri, required: Public url in your services where you plan to receive our webhooks. If you don't have a public url ready yet, you can use Svix play to test our webhooks https://www.svix.com/play/
  - `version` integer, required
  - `disabled` boolean: When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.
  - `filterTypes` string[], nullable
  - `channels` string[], nullable: List of message channels this endpoint listens to (omit for all)
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `400`: Bad request
- `403`: Forbidden
- `404`: Not Found. This endpoint id was not found.
- `422`: Validation Error. The payload does not have the necessary information or format.
- `429`: Too Many Requests
- `500`: Internal Error

---

[API](https://skmtc.dev/safecube/apis/webhook-api.md) - [All operations](https://skmtc.dev/safecube/apis/webhook-api/llms.txt) - [OpenAPI document](https://skmtc.dev/safecube/apis/webhook-api/revisions/86d07c02c618?raw)