editDocument

@PATCH(value = documents/{id})
abstract suspend fun editDocument(@Path(value = id) id: String, @Body() editDocumentRequestDto: EditDocumentRequestDto): Response<EditDocumentResponseDto>
Content copied to clipboard

Update a document This endpoint allows you to update a specific subset of data for a single document given its ID. \\ The schema defined below outlines the fields which can be updated. To unset a specific field you can pass empty string or null. Numeric or Enum fileds must be null to unset. * Responses:

  • 200: Successful response - returns the Id of the updated document

  • 400: Bad Request. This will occur if you provide an invalid value for a request parameter.

  • 401: Unauthorized. This will occur if you do not supply an access-token to this endpoint, or if you provide an expired or invalid access token.

  • 403: Forbidden. This will occur if you try to use this endpoint without being setup for documents.

  • 404: Not Found. The document ID you have provided is not one of this user's documents.

  • 500: Internal Server Error.

Return

EditDocumentResponseDto

Parameters

id

A unique Id that identifies this document in the Sensibill system.

editDocumentRequestDto

An object composed of all the fields you want to edit for the given document.