Edit the subscription details
Edit the details of an existing subscription.
By invoking this API, users can update the parameters and preferences associated with a specific subscription identified by the subscription ID. The subscription id Unique UUID for track the end to end request transaction 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 Suffix of the consent manager to which the request was intended JWT Authentication token which was issued by ABDM after successful validation of username and password The service ID of the health information provider Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" A boolean value to denote if the policy is applicable to all the HIPs or only the specified HIP Included sources, carrying the list of hi types. Types of health information document. One of One of The reference URL.Allows alpha numeric character and special characters like "^[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&//=]*)$" Identifier and name of the health information provider. The service ID of the health information provider. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 //_//-]*[A-Z a-z 0-9]$ The name of the health information provider. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The type of the health information provider. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The date range between when the subscription will be active UTC date time in ISO format. Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" UTC date time in ISO format. Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" The status of the subscription approval Excluded sources, carrying the list of hi types. Types of health information document. One of One of The reference URL. Allows alpha numeric character and special characters like "^[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&//=]*)$" Identifier and name of the health information provider. The service ID of the health information provider. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 //_//-]*[A-Z a-z 0-9]$ The name of the health information provider. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The type of the health information provider. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The date range between when the subscription will be active UTC date time in ISO format.Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" UTC date time in ISO format.Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" The status of the subscription approval Bad Request Forbidden server cannot find the requested resource Internal Server Error -> It is just one example, for every api the path will be changed. Service UnavailableAuthorizations
Authorizationbearer tokenRequiredPath parameters
subscription-idstringRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredBody
hiuIdstringRequiredsubscriptionEditAndApprovalRequestobjectRequiredsubscriptionEditAndApprovalRequest.isApplicableForAllHIPsbooleanRequiredsubscriptionEditAndApprovalRequest.includedSourcesobject[]RequiredsubscriptionEditAndApprovalRequest.includedSources.hiTypesstring[]RequiredsubscriptionEditAndApprovalRequest.includedSources.purposeobjectRequiredsubscriptionEditAndApprovalRequest.includedSources.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf RequestedsubscriptionEditAndApprovalRequest.includedSources.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTsubscriptionEditAndApprovalRequest.includedSources.purpose.refUristringRequiredsubscriptionEditAndApprovalRequest.includedSources.hipobjectRequiredsubscriptionEditAndApprovalRequest.includedSources.hip.idstringRequiredsubscriptionEditAndApprovalRequest.includedSources.hip.namestringRequiredsubscriptionEditAndApprovalRequest.includedSources.hip.typestringsubscriptionEditAndApprovalRequest.includedSources.categoriesstring[]RequiredsubscriptionEditAndApprovalRequest.includedSources.periodobjectRequiredsubscriptionEditAndApprovalRequest.includedSources.period.fromstringRequiredsubscriptionEditAndApprovalRequest.includedSources.period.tostringRequiredsubscriptionEditAndApprovalRequest.includedSources.statusstringRequiredsubscriptionEditAndApprovalRequest.excludedSourcesobject[]RequiredsubscriptionEditAndApprovalRequest.excludedSources.hiTypesstring[]RequiredsubscriptionEditAndApprovalRequest.excludedSources.purposeobjectRequiredsubscriptionEditAndApprovalRequest.excludedSources.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf RequestedsubscriptionEditAndApprovalRequest.excludedSources.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTsubscriptionEditAndApprovalRequest.excludedSources.purpose.refUristringRequiredsubscriptionEditAndApprovalRequest.excludedSources.hipobjectRequiredsubscriptionEditAndApprovalRequest.excludedSources.hip.idstringRequiredsubscriptionEditAndApprovalRequest.excludedSources.hip.namestringRequiredsubscriptionEditAndApprovalRequest.excludedSources.hip.typestringsubscriptionEditAndApprovalRequest.excludedSources.categoriesstring[]RequiredsubscriptionEditAndApprovalRequest.excludedSources.periodobjectRequiredsubscriptionEditAndApprovalRequest.excludedSources.period.fromstringRequiredsubscriptionEditAndApprovalRequest.excludedSources.period.tostringRequiredsubscriptionEditAndApprovalRequest.excludedSources.statusstringRequiredResponses
400403404500503