Update endpoint

PATCH

/v1/endpoints/{id}

• Production

Update an existing endpoint. Only provided fields are updated; omitted fields retain their current values.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

/^ep_[a-f0-9]{32}$/

Endpoint identifier (ep_ prefix + 32 hex chars)

Example

ep_550e8400e29b41d4a716446655440000

Request Body ^required

object

url

Updated endpoint URL

string format: uri

>= 12 characters <= 2048 characters /^https:///

Example

https://new-customer.app/webhooks

description

Updated description

string

<= 500 characters

rate_limit_rps

Updated rate limit

integer

<= 1000

burst

Updated burst size

integer

<= 10000

headers

Updated custom headers

object

key

additional properties

string

Examples

Update URL only

{
  "url": "https://new-customer.app/webhooks"
}

Update rate limiting

{
  "rate_limit_rps": 20,
  "burst": 40
}

Responses

200

Endpoint updated successfully

object

data

object

id

Endpoint ID

string

Example

ep_550e8400e29b41d4a716446655440000

updated

Whether the update was successful

boolean

Example

true

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "data": {
    "id": "ep_550e8400e29b41d4a716446655440000",
    "updated": true
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

404

Resource not found

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Message not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}