POST Subscription Confirmation

Confirm a subscription to CDS document notifications

POST /v1/subscriptions/confirmations

Requires Auth?

Yes. See the Getting Started page for more details.

Description

This endpoint allows a client to confirm their subscription to CDS document notifications. This message requires a JSON-encoded body containing data sent from a CDS subscription confirmation message.

Response Codes

Response Code Meaning
200 The subscription has been confirmed
400 The data sent was invalid; see the meta.messages attribute in the body for more information
401 The Authorization token provided in the request was not associated with a recognized CDS client

Example Error Response

{
  "meta": {
    "messages": [
      "Error: Could not parse JSON body"
    ]
  }
}

Table of contents


© 2024 npr