Creates a attachment link using the provided parameters.
API Reference
//
Get Link Status
Hero Health Public API (1.0.0)
Download OpenAPI description
Languages
Servers
Mock server
https://developer.herohealth.net/_mock/apis/public-api/openapi/
Staging
https://api.staging.htech.app/
Production
https://api.herohealth.net/
Bodyapplication/jsonrequired
File ID retrieved from List Patient Attachments endpoint. If not provided, file_data must be provided.
- Mock serverhttps://developer.herohealth.net/_mock/apis/public-api/openapi/v1/attachment_links
- Staginghttps://api.staging.htech.app/v1/attachment_links
- Productionhttps://api.herohealth.net/v1/attachment_links
- curl
- NodeJS
- Ruby
curl -i -X POST \
https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/attachment_links \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-practice-group-id: YOUR_API_KEY_HERE' \
-d '{
"expiry_date": "1989-04-11",
"ehr_file_id": "string",
"file_data": "string",
"file_name": "string",
"patient_id": "string",
"maximum_use_count": 1
}'Response
application/json
{ "attachment_link": "string", "attachment_uuid": "string" }
- Mock serverhttps://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links
- Staginghttps://api.staging.htech.app/v1/booking_links
- Productionhttps://api.herohealth.net/v1/booking_links
- curl
- NodeJS
- Ruby
curl -i -X POST \
https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-practice-group-id: YOUR_API_KEY_HERE' \
-d '{
"slot_id": "string",
"appointment_type_id": "string",
"location_id": "string",
"patient_id": "string",
"practitioner_id": "string",
"from_date": "1989-04-11",
"to_date": "1989-04-11",
"expiry_date": "1989-04-11",
"maximum_use_count": 1,
"link_name": "string"
}'Response
application/json
{ "booking_link": "string", "short_link_id": "string" }
Bodyapplication/jsonrequired
Display only the slots available after this date
Example: "1989-04-11"
Display only the slots available before this date
Example: "1989-04-11"
- Mock serverhttps://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links/{id}
- Staginghttps://api.staging.htech.app/v1/booking_links/{id}
- Productionhttps://api.herohealth.net/v1/booking_links/{id}
- curl
- NodeJS
- Ruby
curl -i -X PATCH \
'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links/{id}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-practice-group-id: YOUR_API_KEY_HERE' \
-d '{
"appointment_type_id": "string",
"location_id": "string",
"practitioner_id": "string",
"expiry_date": "1989-04-11",
"maximum_use_count": 1,
"from_date": "1989-04-11",
"to_date": "1989-04-11",
"active": true,
"link_name": "string"
}'Response
application/json
{ "booking_link": "string", "short_link_id": "string" }
- Mock serverhttps://developer.herohealth.net/_mock/apis/public-api/openapi/v1/form_links
- Staginghttps://api.staging.htech.app/v1/form_links
- Productionhttps://api.herohealth.net/v1/form_links
- curl
- NodeJS
- Ruby
curl -i -X POST \
https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/form_links \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-practice-group-id: YOUR_API_KEY_HERE' \
-d '{
"form_id": "string",
"patient_id": "string",
"expiry_date": "1989-04-11",
"maximum_use_count": 1
}'Response
application/json
{ "form_link": "string", "short_link_id": "string" }
- Mock serverhttps://developer.herohealth.net/_mock/apis/public-api/openapi/v1/links/status
- Staginghttps://api.staging.htech.app/v1/links/status
- Productionhttps://api.herohealth.net/v1/links/status
- curl
- NodeJS
- Ruby
curl -i -X GET \
'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/links/status?url=https%3A%2F%2Fbookings.herohealth.net%2Fs%2Fabc123&id=12345' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-practice-group-id: YOUR_API_KEY_HERE'Response
application/json
{ "status": "unused", "type": "booking", "reference": [ { … } ] }
- Mock serverhttps://developer.herohealth.net/_mock/apis/public-api/openapi/v1/video_links
- Staginghttps://api.staging.htech.app/v1/video_links
- Productionhttps://api.herohealth.net/v1/video_links
- curl
- NodeJS
- Ruby
curl -i -X POST \
https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/video_links \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-practice-group-id: YOUR_API_KEY_HERE' \
-d '{
"link_name": "string",
"patient_id": "string",
"expiry_date": "1989-04-11"
}'Response
application/json
{ "video_link": "string", "short_link_id": "string", "main_room_url": "string" }