v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Update the status of a document

put/v1/documents/{id}

Path parameters

idinteger required

Specify the ID of the document that you want to update.

Request body

upload_statusstring required

Update the upload status of the document to the Amazon S3. Allowed values are 'Completed' or 'Failed'.

Response

200

Example response

{
  "document": {
    "id": 15310,
    "category": "other",
    "upload_url": "https://keep-truckin-production.s3.amazonaws.com/uploads/document/doc_upload/15310/dispatch.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA5S2T6Q3NJG6GED2D%2F20200403%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200403T214937Z&X-Amz-Expires=86400&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEF0aCXVzLWVhc3QtMSJIMEYCIQDqt05iH2yfG9qVfeesXI0ZyIMofmFWT8cebrexNxm0twIhAI7B%2Fzni6i6w0bFPxnGf69ptbm7O1aeaPixtHqMLVrgJKrQDCGYQABoMOTMzNzk0NTgwMTg2IgzKLQht5RM0G%2BVdnvkqkQMnwJoMQ53Wul56U4qmeFIuPOc3mynFlAUd4qiacIbzbTB0yFk%2BYgU3cU%2FPVJTU0rljRP0gcXaua7eN58csnXX0yc1otwBmc7srE%2BPo1vxu2Dd0OkgfXenNiIJ4MfmF4Mu7PApTlFghpmwm6D5ENi9eHNgMe39Yrx5n0ZdXHK0sYO%2BdMdv8lqkP%2FPb7b6rfRD%2BALulnf0Khw9cAeQJPPf4LBZHF3if3FOdMBNcgYzVw4drZ02uXsifH2Um4iXw46Mr2uuXoXRM67ixBBpBH2Yx7md5plU3FxPSUugK%2BMjm06nlG%2FZqZ4%2BKvzFEeI6aTdL4QWQzcJVKLflPAJid1%2ByJg6LrbXEDyyh4Af4PhnYQ9mSDCogpLhLat9WX6h8Chsin4vjV4q7zb%2BAFPPzU1F3BZESzI8Ogvg7SY2wRIU1EYf4OfoCnQIrOGvLU9HPEz1Nl3hOMPuMJSPu5MYgIMHt6q5PzW1P2v%2FZFP9ZdIQMJMsNywsHEJCGL27aY8yklrFM70rPx9qSZSAgg%2BucUhxe0IJzC8yJ70BTrqAX7RMQvDYiJdSbTQ%2FMNas35eq93PzchKLSK65LPwR8xoNuT8XyLJMyOCMMktytsDbPl8XcFVSM%2Buk1qnw%2BT2Au%2FcZS9Mi9mUlNoPAqO40vvPiky7fcjpPy2DXVjdeBV5SVcgHk4VmQyl%2Fw4GEzhlj84KfZQWZRPhfY%2BBS2bEQ06QXMlg4VN9nMhyQHE%2FecTzUQKhlKpRdCLgTuylz9%2FGY55dB1sWCMxC134Xd9kKNvfNQqgVk7PYoVaIRdMEWsH29UybZyk1QnSUa9s3XbF3viEz%2F8PSg9pbuSQ3hLHbf7k8Mht7iq0EdWOSDg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=1889f02a362481d8efdab7aaa8f198e6ced8b6ce0cbfa9f28e8c1cc1f83bc503",
    "ref_no": "89ABC89",
    "notes": "example",
    "doc_date": "2020-04-03"
  }
}