Skip to main content

Enable the subscription by subscription ID

Enable an existing subscription identified by the subscription ID.

POST/api/hiecm/subscription-requests/v3/enable/{subscription-id}

By invoking this API, users can activate the subscription, ensuring that the associated health information services or updates are delivered as requested. This functionality is essential for managing subscriptions effectively, allowing users to control the activation status of their health data subscriptions. The API supports secure and efficient enablement of subscriptions, enhancing the overall user experience within the healthcare ecosystem.

Authorizations

Authorizationbearer tokenRequired

Path parameters

subscription-idstringRequired

The subscription id

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

X-AUTH-TOKENstringRequired

JWT Authentication token which was issued by ABDM after successful validation of username and password

Responses

200

OK

400

Bad Request

401

Unauthorized

Everything returns 401

403

Forbidden

404

server cannot find the requested resource

500

Internal Server Error -> It is just one example, for every api the path will be changed.

503

Service Unavailable