Create an Attachment Link

Creates a attachment link using the provided parameters.

SecurityapiKeyAuth and practiceGroupId

Request

expiry_date	string <date-time> ISO 8601 date format
ehr_file_id	string File ID retrieved from List Patient Attachments endpoint. If not provided, file_data must be provided.
file_data	string Base 64 representation of a file. Up to 2MB.
file_name required	string non-empty
patient_id required	string^\d+$
maximum_use_count	number >= 1

Responses

200

400

Validation error

401

Unauthorised

422

Patient inexistent and/or Appointment Type inexistent

500

Unknown error

post/v1/attachment_links

Request samples

application/json

{"expiry_date": "1989-04-11",
"ehr_file_id": "string",
"file_data": "string",
"file_name": "string",
"patient_id": "string",
"maximum_use_count": 1
}

Response samples

application/json

{"attachment_link": "string",
"attachment_uuid": "string"
}