> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.staple.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.staple.ai/_mcp/server.

# Update Document Sidebar Fields

POST https://api.staple.io/v2/documents/update-fields
Content-Type: application/json

Update sidebar fields value for a document scanned in a queue configured with custom model.

##### NOTES

-   Endpoint: `POST /v2/documents/update-fields`
-   Each `fieldUuid` must map to a valid queue/model field.
-   Each target field must already exist on the document sidebar JSON.
-   Locked fields cannot be updated.
-   Duplicate updates that resolve to the same field are rejected.

Reference: https://docs.staple.ai/api-reference/v2/documents/update-document-sidebar-fields

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: v2
  version: 1.0.0
paths:
  /v2/documents/update-fields:
    post:
      operationId: updateDocumentSidebarFields
      summary: Update Document Sidebar Fields
      description: >-
        Update sidebar fields value for a document scanned in a queue configured
        with custom model.


        ##### NOTES


        -   Endpoint: `POST /v2/documents/update-fields`

        -   Each `fieldUuid` must map to a valid queue/model field.

        -   Each target field must already exist on the document sidebar JSON.

        -   Locked fields cannot be updated.

        -   Duplicate updates that resolve to the same field are rejected.
      tags:
        - documents
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Documents_updateDocumentSidebarFields_Response_200
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                documentId:
                  type: integer
                qid:
                  type: integer
                fields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/V2DocumentsUpdateFieldsPostRequestBodyContentApplicationJsonSchemaFieldsItems
servers:
  - url: https://api.staple.io
    description: https://api.staple.io
components:
  schemas:
    V2DocumentsUpdateFieldsPostRequestBodyContentApplicationJsonSchemaFieldsItems:
      type: object
      properties:
        fieldUuid:
          type: string
        value:
          type: string
      title: >-
        V2DocumentsUpdateFieldsPostRequestBodyContentApplicationJsonSchemaFieldsItems
    Documents_updateDocumentSidebarFields_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Documents_updateDocumentSidebarFields_Response_200

```

## Examples



**Request**

```json
{
  "documentId": 243246,
  "qid": 4308,
  "fields": [
    {
      "fieldUuid": "2a705980-cf29-4ff8-aa5a-85d52584bf45",
      "value": "adress"
    }
  ]
}
```

**Response**

```json
{}
```

**SDK Code**

```python Documents_updateDocumentSidebarFields_example
import requests

url = "https://api.staple.io/v2/documents/update-fields"

payload = {
    "documentId": 243246,
    "qid": 4308,
    "fields": [
        {
            "fieldUuid": "2a705980-cf29-4ff8-aa5a-85d52584bf45",
            "value": "adress"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Documents_updateDocumentSidebarFields_example
const url = 'https://api.staple.io/v2/documents/update-fields';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"documentId":243246,"qid":4308,"fields":[{"fieldUuid":"2a705980-cf29-4ff8-aa5a-85d52584bf45","value":"adress"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Documents_updateDocumentSidebarFields_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staple.io/v2/documents/update-fields"

	payload := strings.NewReader("{\n  \"documentId\": 243246,\n  \"qid\": 4308,\n  \"fields\": [\n    {\n      \"fieldUuid\": \"2a705980-cf29-4ff8-aa5a-85d52584bf45\",\n      \"value\": \"adress\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Documents_updateDocumentSidebarFields_example
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/v2/documents/update-fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"documentId\": 243246,\n  \"qid\": 4308,\n  \"fields\": [\n    {\n      \"fieldUuid\": \"2a705980-cf29-4ff8-aa5a-85d52584bf45\",\n      \"value\": \"adress\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Documents_updateDocumentSidebarFields_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.staple.io/v2/documents/update-fields")
  .header("Content-Type", "application/json")
  .body("{\n  \"documentId\": 243246,\n  \"qid\": 4308,\n  \"fields\": [\n    {\n      \"fieldUuid\": \"2a705980-cf29-4ff8-aa5a-85d52584bf45\",\n      \"value\": \"adress\"\n    }\n  ]\n}")
  .asString();
```

```php Documents_updateDocumentSidebarFields_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.staple.io/v2/documents/update-fields', [
  'body' => '{
  "documentId": 243246,
  "qid": 4308,
  "fields": [
    {
      "fieldUuid": "2a705980-cf29-4ff8-aa5a-85d52584bf45",
      "value": "adress"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Documents_updateDocumentSidebarFields_example
using RestSharp;

var client = new RestClient("https://api.staple.io/v2/documents/update-fields");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"documentId\": 243246,\n  \"qid\": 4308,\n  \"fields\": [\n    {\n      \"fieldUuid\": \"2a705980-cf29-4ff8-aa5a-85d52584bf45\",\n      \"value\": \"adress\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Documents_updateDocumentSidebarFields_example
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "documentId": 243246,
  "qid": 4308,
  "fields": [
    [
      "fieldUuid": "2a705980-cf29-4ff8-aa5a-85d52584bf45",
      "value": "adress"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/documents/update-fields")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```