Editing document parameters

To edit document parameters, send a POST request to https://digidoc.1dox.site/api/editdocumentparams

Request body parameters

Name	Type	Example	Description	Required?
document_oid	number	10001010	System file oid	Yes
document_name	string	Test	New document name without the extension. Document container extension will remain the same. Name will remain unchanged on empty value given.	No
document_access	string	url	New access value for the document. Allowed values url – document is visible to anyone with the URL of the document. limited – document is visible only to the document owner, signers, expected signers and viewers me – document is only visible to the owner	No
document_note	string	This is an example note for a document.	A new note for the document. Empty value deletes note.	No
document_company	number	12595949	Company registry number. Note: only registry numbers issued by the Estonian Business Register are currently supported	No
document_folder	number	10001010	System folder oid given during folder creation request	No
document_lock_signing	boolean	1	Lock document signing so no other expected signatures can be added	No

Example request

curl -L -X POST 'https://digidoc.1dox.site/api/editdocumentparams' \
-H 'X-API-Key: <your api key>' \
--data-raw '{                       
    "document_oid": 10001010,
    "document_name": " Test",
    "document_access": "url",
    "document_note": "This is an example note for a document.",
    "document_company": 12595949,
    "document_folder": 10001010,
    "document_lock_signing": 1
}'

Response

Name	Type	Example	Description
status	number	1	Request status 1 – OK 2 – error
statusmessage	string	OK	Request status as a string message
error	string	Error editing document params.	Only for request status 2, an error message is returned

Example successful response

{
    "status": 1,
    "statusmessage": "OK"
}

Example error response

{
    "status": 2,
    "error": "Error editing document params."
}