PUT creates or updates integrators registration

put

/api/v1/notifications/registration

{basePath}/notifications/registration

The API is used to register or update subscriber. Intended to be used when subscriber's keyId, hmacKey, or keyType update is required. Existing subscriptions will remain intact and any notifications that are sent related to the subscription will utilize the newly updated details.

Request

Supported Media Types
Body ()
The SubscriberSecretView
Root Schema : SubscriberSecretView
Type: object
A subscriber subset excluding subscriberId
Show Source
Back to Top

Response

Supported Media Types

201 Response

201 Created
Headers

204 Response

204 No Content

401 Response

401 Unauthorized
Headers
  • Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.

    The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.

    No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer

    Expired token: The access token has expired. The timestamp in this example is illustrative.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"

    Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"

    Invalid signature: The token signature is invalid. For example, the token may have been modified.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"

    For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.

    The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.

Back to Top

Examples

Example Request Body

The following example shows the contents of the request body in JSON format:


{
  "keyId": "string",
  "hmacKey": "string",
  "keyType": "string"
}

Example Response Body

Not applicable for this endpoint.

Back to Top