GOgomotive

Update the status of a document (v2)

put/v2/documents/{id}

Request

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": 13992548,
    "category": "notes",
    "ref_no": "ref",
    "notes": "notes",
    "doc_date": "2021-01-01",
    "doc_fields": {
      "notes": "notes"
    },
    "doc_time": "2021-10-14T22:30:31Z",
    "uploader": {
      "id": 1044876,
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@keeptruckin.com",
      "role": "dispatcher"
    },
    "attachments": [
      {
        "id": 13992548,
        "name": "attach1",
        "upload_url": "/path/of/document/url",
        "doc_type": "jpeg"
      }
    ],
    "created_at": "2021-10-14T22:33:00Z",
    "updated_at": "2021-10-14T22:43:59.001248Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.