DOdocsumo
Data Extraction

Update a Field's Value

Changed on

Update the value of a single field (a key-value pair or a table cell) within a specific document. Identify the document by doc_id and the field by field_id.

patch/api/v1/pik/apikey/{doc_id}/field/{field_id}/

Request

  • Base URL
    https://app.docsumo.com
  • URL
    https://app.docsumo.com/api/v1/pik/apikey/{doc_id}/field/{field_id}/
  • Auth
    none declared

Path parameters

doc_idstring required

The unique identifier for the user document.

field_idinteger required

The unique identifier of the field to update.

Headers

x-api-keystring

Your personal API key for authentication. You can find it on your Docsumo settings page.

Request body

valuestring required

The new value for the field.

Response

OK

errorstring

A message describing any errors encountered during the request.

error_codestring

A code representing the specific error, if any.

messagestring

A confirmation message for the successful operation.

statusstring

The status of the request.

status_codeinteger

The HTTP status code of the response.

Changes

  • 3e025845cf50Revision changes
    • breaking

      for the path request parameter field_id, the type changed from string to integer

    • breaking

      the request property became required

    • breaking

      the // response's property type changed from object to number for status

    • warning

      deleted the header request parameter apikey

    • info

      api operation id update-a-fields-value removed and replaced with

    • info

      api tag Data Extraction added

    • info

      added the new optional header request parameter x-api-key

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value true was removed for the status

    • info

      the response's property default value 0 was removed for the status

    • info

      the response's property default value 0 was removed for the status