Update Field Mapping

Endpoint Name: URL/klearstack/updatemappingdataapi

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The updatemappingdataapi endpoint will be used to update enable / disable fields or update the settings of fields.

Method	URL
POST	URL/klearstack/updatemappingdataapi

Request Body

Params	Values	Description
company_name	string	Name of the company for which the user is logging in
username	string	User Name
collection_name	string	Document Type
data		[{ "documentTypeDetails": { "invoices": { "fields": { "doc_number_value": { "label": "Invoice Number", "required": true, "visibility": true } } } } }]

Shell (cURL)

• Request Body

curl -X POST "URL/klearstack/updatemappingdataapi" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_token_here" \
  -d '{
    "company_name": "Replace_Company_Name_Here",
    "username": "Replace_Username_Here",
    "collection_name": "Replace_Collection_Name_Here",
    "data": [{
      "documentTypeDetails": {
        "invoices": {
          "fields": {
            "doc_number_value": {
              "label": "Invoice Number",
              "required": true,
              "visibility": true
            }
          }
        }
      }
    }]
  }'

Python

• Request Body

import requests

# API URL
url = "URL/klearstack/updatemappingdataapi"

# Request payload
data = {
    "company_name": "Replace_Company_Name_Here",
    "username": "Replace_Username_Here",
    "collection_name": "Replace_Collection_Name_Here",
    "data": [{
        "documentTypeDetails": {
            "invoices": {
                "fields": {
                    "doc_number_value": {
                        "label": "Invoice Number",
                        "required": True,
                        "visibility": True
                    }
                }
            }
        }
    }]
}

# Headers
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer your_token_here"
}

# Make the POST request
response = requests.post(url, json=data, headers=headers)

# Print the response
if response.status_code == 200:
    print(response.json())
else:
    print("Error:", response.text)

Java

• Request Body

import okhttp3.*;

import java.io.IOException;

public class UpdateMappingDataAPI {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        // JSON payload
        String jsonPayload = "{ \"company_name\": \"Replace_Company_Name_Here\", " +
                "\"username\": \"Replace_Username_Here\", " +
                "\"collection_name\": \"Replace_Collection_Name_Here\", " +
                "\"data\": [{ \"documentTypeDetails\": { \"invoices\": { \"fields\": { " +
                "\"doc_number_value\": { \"label\": \"Invoice Number\", \"required\": true, \"visibility\": true } " +
                "} } } }] }";

        RequestBody body = RequestBody.create(
            jsonPayload, MediaType.parse("application/json"));

        Request request = new Request.Builder()
            .url("URL/klearstack/updatemappingdataapi")
            .post(body)
            .addHeader("Content-Type", "application/json")
            .addHeader("Authorization", "Bearer your_token_here")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println("Response: " + response.body().string());
            } else {
                System.out.println("Error: " + response.body().string());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Node.js

• Request Body

var request = require('request');

const payload = {
  "company_name": "Replace_Company_Name_Here",
  "username": "Replace_Username_Here",
  "collection_name": "Replace_Collection_Name_Here",
  "data": [{
    "documentTypeDetails": {
      "invoices": {
        "fields": {
          "doc_number_value": {
            "label": "Invoice Number",
            "required": true,
            "visibility": true
          }
        }
      }
    }
  }]
};

const options = {
  url: 'URL/klearstack/updatemappingdataapi',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_token_here'
  },
  json: payload
};

request.post(options, function(err, httpResponse, body) {
  if (err) {
    console.error('Request failed:', err);
    return;
  }

  console.log('Response:', body);
});

JavaScript (XMLHttpRequest)

• Request Body

var payload = JSON.stringify({
    company_name: "Replace_Company_Name_Here",
    username: "Replace_Username_Here",
    collection_name: "Replace_Collection_Name_Here",
    data: [{
        documentTypeDetails: {
            invoices: {
                fields: {
                    doc_number_value: {
                        label: "Invoice Number",
                        required: true,
                        visibility: true
                    }
                }
            }
        }
    }]
});

var xhr = new XMLHttpRequest();
xhr.open("POST", "URL/klearstack/updatemappingdataapi", true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

// Handle response
xhr.onreadystatechange = function () {
    if (xhr.readyState === XMLHttpRequest.DONE) {
        if (xhr.status === 200) {
            console.log("Response:", xhr.responseText);
        } else {
            console.error("Error:", xhr.responseText);
        }
    }
};

xhr.send(payload);

API Response

Status code	Example Response
200	Request Submitted Successfully