Saltar al contenido principal
PATCH
Re-pin a subscription's schema major

Autorizaciones

Authorization
string
header
requerido

A bearer JWT issued by Access Manager. The /v1 surface never reads a tenant from the body, path, or query. Machine callers obtain a token with the Access Manager client-credentials flow. The /admin surface authorizes against an operator scope and carries no tenant context.

Encabezados

X-Idempotency
string
requerido

A client-chosen unique key that makes this mutation at-most-once. A mutation sent without it is rejected before any write with 400 missing_idempotency_key. Reusing the same key with an identical request replays the original response byte-for-byte (with X-Idempotency-Replayed: true); reusing it with a different request body returns 409 idempotency_conflict. To re-drive a corrected request, mint a new key.

Parámetros de ruta

id
string<uuid>
requerido

The unique identifier of the subscription (UUIDv7).

Cuerpo

application/json

The narrow change body. schema_major is required: an integer >= 1 re-pins; null clears the pin. timeout_ms is optional. Any other field or an empty body is rejected with 422 validation_error.

schema_major
integer | null
requerido

The schema major to pin, or null to follow major 1. A value < 1 is rejected.

Ejemplo:

1

timeout_ms
integer

The per-attempt delivery timeout in milliseconds, from 1000 to 20000. For webhook subscriptions only: the hub refuses a non-zero value for any other sink kind. Omit it to keep the stored timeout; send 0 to return to the 10000 default.

Ejemplo:

20000

Respuesta

The re-pin succeeded (no body).