Update Request Document function

GET https://api.liveconsent.com/LCSWS/request/updatedocument

This method updates details for an LCS request document.
API function usage type: Standard

HTTP Request

Request Content-Type: application/json

JSON BODY PARAMS - name and value pairs description:

• request_id: LCS request identifier to update; Value of "request_id" or "unique_submit_id". JSON Data Type: String
• request_id_type (optional): Type of LCS identifier for "request_id" field; Values: "request_id" or "unique_submit_id"; Default value: "request_id"; JSON Data Type: String
• document_filename: filename of PDF document to update; Value: String
• update_field_name: update field name; Value: Sting
• update_field_value: update field value; Value: value of updated field name of document

Valid update_field_name values for an LCS request document are: document_custom, document_metadata, document_name.
For update_field_value parameter values see Create Request function - document JSON object.

Exemples of JSON for Update Request Document

Example of HTTP Request JSON Body data for update document_custom:

JSON

{
	"request_id": "02GB0G",
	"request_id_type": "request_id",
	"document_filename": "Document1.pdf",
	"update_field_name": "document_custom",
	"update_field_value": "New document custom value"
}