Update the status of a document

Purpose: Use this API to update the status of a document upload to the Amazon S3 bucket. This endpoint is mostly used for updating the status of the dispatching documents. After you send the dispatch document, you must use the upload_url and upload the document in the S3 bucket.

After you upload the document, you must mark the same document as completed.

Response Parameters

document

  • Type: Object
  • Description: Details of the uploaded document.

id

  • Type: Integer
  • Description: The unique identifier for the document.

category

  • Type: String
  • Description: The category of the document, e.g., "other".

upload_url

  • Type: String
  • Description: The URL where the document is to be uploaded.

ref_no

  • Type: String
  • Description: The reference number associated with the document.

notes

  • Type: String
  • Description: Notes associated with the document.

doc_date

  • Type: Date (YYYY-MM-DD)
  • Description: The date the document was created.

doc_fields

  • Type: Array of Objects (nullable)
  • Description: Custom fields associated with the document.

doc_time

  • Type: DateTime (ISO 8601)
  • Description: The time the document was created.

Language
Credentials
Header
Click Try It! to start a request and see the response here!