Update Destination

Updates an existing destination configuration.

POST /destinations/{destinationId}

This endpoint updates an existing event destination's configuration. You can modify the destination name, URL, subscribed event types, description, or status.

You can use this endpoint to enable or disable a destination (status) without deleting it. This is useful when you need to pause event delivery to a destination during maintenance or troubleshooting.

1. Call this endpoint with the destination's ID and the properties you want to update.
2. Stedi updates the destination.
3. The endpoint returns the updated configuration.

Authorizations

Authorization · Required Header

A Stedi API Key for authentication. Supports both test and production API keys.

Path Parameters

destinationId · String Regex pattern : ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The unique identifier for the destination. You can retrieve destination IDs with the List Destinations endpoint.

Headers

Idempotency-Key · String Length : 1 - 255

A unique string to identify this request to the server. If not set, Stedi generates one automatically.

The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. Learn more.

Body

application/json

concurrencyLimit · Number Range : ≥ 1

Maximum concurrent deliveries for this destination. If not set, Stedi applies your account default (typically 5). Stedi rejects requests exceeding your account maximum (typically 20) with a 400 error. Contact Stedi to change your limits.

description · String Max length : 1024

A description of the destination's purpose, such as "Receives transaction enrollment task notifications."

destinationUrl · String Regex pattern : ^https://.+$

The URL where you want Stedi to deliver payloads through HTTP POST.

eventTypes · Array of Strings Min items : 1

The event types you want Stedi to send to this destination. Visit event types for a complete list.

name · String Length : 1 - 255

A human-readable name for the destination. Stedi displays this name in the portal.

status · String

The destination's status. Set to ENABLED to receive event deliveries or DISABLED to pause them.

Possible values

ENABLED

DISABLED

Response

application/json

concurrencyLimit · Number Range : ≥ 1

The maximum number of concurrent deliveries for this destination. Contact Stedi to change your account limits.

createdAt · String Required Format : date-time

Creation timestamp for this destination.

description · String Required Max length : 1024

A description of the destination's purpose, such as "Receives transaction enrollment task notifications."

destinationUrl · String Required Regex pattern : ^https://.+$

The URL where Stedi delivers payloads through HTTP POST.

eventTypes · Array of Strings Required Min items : 1

The event types Stedi sends to this destination. Visit event types for a complete list.

id · String Required Regex pattern : ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The unique identifier for the destination.

lastDeliveryTime · String Format : date-time

The timestamp for Stedi's most recent delivery attempt to this destination. Absent when Stedi hasn't yet attempted a delivery.

name · String Required Length : 1 - 255

A human-readable name for the destination. Stedi displays this name in the portal.

status · String Required

The destination's current status. Stedi only sends event payloads to ENABLED destinations.

Possible values

ENABLED

DISABLED

updatedAt · String Required Format : date-time

Last update timestamp for this destination.

Request

curl --request POST \
  --url "https://events.us.stedi.com/2026-02-01/destinations/{destinationId}" \
  --header "Idempotency-Key: b2c3d4e5-f6a7-8901-bcde-f12345678901" \
  --header "Authorization: <api_key>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated Destination Name",
    "status": "DISABLED"
  }'

Response

{
  "createdAt": "2026-02-01T12:00:00Z",
  "description": "",
  "destinationUrl": "https://example.com/webhooks",
  "eventTypes": [
    "enrollment.activated"
  ],
  "id": "dst_550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated Destination Name",
  "status": "DISABLED",
  "updatedAt": "2026-02-02T08:30:00Z"
}