Skip to content

Update document

Only document state can be updated for now. Supported states are: ready, exported

PATCH/api/v1_2/documents/:document_id

Only document state can be updated for now. Supported states are: ready, exported

Path parameters

Name Example Description
document_id — —

Headers

Name Example Description
Content-Type application/json —

Request body

{
  "document": {
    "state": "exported"
  }
}

Code examples

curl --request PATCH 'https://app.datamolino.com/api/v1_2/documents/98765' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer demo_access_token' \
  --data '{
  "document": {
    "state": "exported"
  }
}'
PATCH /api/v1_2/documents/98765 HTTP/1.1
Host: app.datamolino.com
Content-Type: application/json
Authorization: Bearer demo_access_token

{
  "document": {
    "state": "exported"
  }
}
const response = await fetch("https://app.datamolino.com/api/v1_2/documents/98765", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer demo_access_token"
  },
  body: JSON.stringify({
    "document": {
      "state": "exported"
    }
  }),
});

const data = await response.json();
import axios from "axios";

const response = await axios({
  method: "patch",
  url: "https://app.datamolino.com/api/v1_2/documents/98765",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer demo_access_token"
  },
  data: {
    "document": {
      "state": "exported"
    }
  }
});

console.log(response.data);
import requests

url = "https://app.datamolino.com/api/v1_2/documents/98765"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer demo_access_token"
}
payload = {
  "document": {
    "state": "exported"
  }
}

response = requests.request("PATCH", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())
require 'json'
require 'net/http'

uri = URI("https://app.datamolino.com/api/v1_2/documents/98765")
request = Net::HTTP::Patch.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer demo_access_token"
request.body = <<~JSON
{
  "document": {
    "state": "exported"
  }
}
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)
# app/services/datamolino_client.rb
require 'json'
require 'net/http'

class DatamolinoClient
  BASE_URL = "https://app.datamolino.com"

  def initialize(access_token: Rails.application.credentials.dig(:datamolino, :access_token))
    @access_token = access_token
  end

  def request_update_document
    uri = URI("#{BASE_URL}/api/v1_2/documents/98765")
    request = Net::HTTP::Patch.new(uri)
    request["Content-Type"] = "application/json"
    request["Authorization"] = "Bearer #{@access_token}"
    request.body = <<~JSON
      {
        "document": {
          "state": "exported"
        }
      }
    JSON

    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
      http.request(request)
    end

    JSON.parse(response.body)
  end
end
<?php

use GuzzleHttp\Client;

$client = new Client();
$response = $client->request('PATCH', 'https://app.datamolino.com/api/v1_2/documents/98765', [
    'headers' => json_decode('{"Content-Type":"application/json","Authorization":"Bearer demo_access_token"}', true),
    'json' => json_decode('{"document":{"state":"exported"}}', true)
]);

echo $response->getBody();
OkHttpClient client = new OkHttpClient();

RequestBody body = RequestBody.create("{\n  \"document\": {\n    \"state\": \"exported\"\n  }\n}", MediaType.parse("application/json"));
Request request = new Request.Builder()
    .url("https://app.datamolino.com/api/v1_2/documents/98765")
    .addHeader("Content-Type", "application/json")
    .addHeader("Authorization", "Bearer demo_access_token")
    .method("PATCH", body)
    .build();

Response response = client.newCall(request).execute();
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://app.datamolino.com/api/v1_2/documents/98765");
request.Headers.Add("Authorization", "Bearer demo_access_token");
request.Content = new StringContent("{\n  \"document\": {\n    \"state\": \"exported\"\n  }\n}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
client := &http.Client{}
req, err := http.NewRequest("PATCH", "https://app.datamolino.com/api/v1_2/documents/98765", strings.NewReader("{\n  \"document\": {\n    \"state\": \"exported\"\n  }\n}"))
if err != nil { panic(err) }
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer demo_access_token")

res, err := client.Do(req)
if err != nil { panic(err) }
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil { panic(err) }
fmt.Println(string(body))
import Foundation

var request = URLRequest(url: URL(string: "https://app.datamolino.com/api/v1_2/documents/98765")!)
request.httpMethod = "PATCH"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("Bearer demo_access_token", forHTTPHeaderField: "Authorization")
request.httpBody = "{\n  \"document\": {\n    \"state\": \"exported\"\n  }\n}".data(using: .utf8)

let (data, _) = try await URLSession.shared.data(for: request)
print(String(data: data, encoding: .utf8)!)

Responses

200 OK

Content type: application/json; charset=utf-8

{
  "document": {
    "state": "exported"
  },
  "message": "Successfully updated"
}

400 Bad Request

Content type: application/json; charset=utf-8

{
  "message": "Invalid state name"
}
Navigation

Type to search…

↑↓ navigate ↵ select Esc close