9205: Update document
- Usman Tanveer
- Nick Jensen
Owned by Usman Tanveer
Update a document for an account. This endpoint may also be used to move a document to another entity, by setting the
moveToEntityID property.Endpoint ID: | 9205 | |||||
| Method: | PUT | |||||
| URL: | /entity/id/{entityID}/documents/{documentID} /entity/ext-key/{externalRelationID}/{externalRelationType}/documents/{documentID} | |||||
entityID | Rubiq entity ID that uniquely identifies an account to return data for | |||||
externalRelationID | External key that uniquely identifies an account to return data for | |||||
externalRelationType | Type of external key | |||||
| Request body: | None | All properties are optional, only the properties that are included in the request will be updated. Example Request {
"content": "base64 encoded text",
"compressed": false,
"description": "Description of the document",
"expiryDate": "31-12-2016T23:59:59",
"mimeType": "image",
"name": "Test Document",
"sizeCompressed": 500,
"sizeOriginal": 1500,
"moveToEntityID": 12345
}
| ||||
Response body: | None | |||||
| Status codes: | 204 | Document updated with success | ||||
| 404 | Account was not found, or the document was not found for the account. The following sub codes may be returned:
| |||||