Create Document
curl --request POST \
--url https://app.toku.com/api/tokuApi/v1/createDocument \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-role-type: <x-role-type>' \
--data '
{
"roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentType": "GRANT_AGREEMENT",
"documentName": "Grant Agreement - Jane Smith",
"fileKey": "<string>",
"documentDescription": "<string>",
"visibleToEmployee": true,
"visibleToClientAdmin": true,
"grantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://app.toku.com/api/tokuApi/v1/createDocument"
payload = {
"roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentType": "GRANT_AGREEMENT",
"documentName": "Grant Agreement - Jane Smith",
"fileKey": "<string>",
"documentDescription": "<string>",
"visibleToEmployee": True,
"visibleToClientAdmin": True,
"grantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-role-type": "<x-role-type>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-role-type': '<x-role-type>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
roleInOrgID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
documentType: 'GRANT_AGREEMENT',
documentName: 'Grant Agreement - Jane Smith',
fileKey: '<string>',
documentDescription: '<string>',
visibleToEmployee: true,
visibleToClientAdmin: true,
grantID: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://app.toku.com/api/tokuApi/v1/createDocument', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.toku.com/api/tokuApi/v1/createDocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'roleInOrgID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'documentType' => 'GRANT_AGREEMENT',
'documentName' => 'Grant Agreement - Jane Smith',
'fileKey' => '<string>',
'documentDescription' => '<string>',
'visibleToEmployee' => true,
'visibleToClientAdmin' => true,
'grantID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-role-type: <x-role-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.toku.com/api/tokuApi/v1/createDocument"
payload := strings.NewReader("{\n \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentType\": \"GRANT_AGREEMENT\",\n \"documentName\": \"Grant Agreement - Jane Smith\",\n \"fileKey\": \"<string>\",\n \"documentDescription\": \"<string>\",\n \"visibleToEmployee\": true,\n \"visibleToClientAdmin\": true,\n \"grantID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-role-type", "<x-role-type>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.toku.com/api/tokuApi/v1/createDocument")
.header("x-role-type", "<x-role-type>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentType\": \"GRANT_AGREEMENT\",\n \"documentName\": \"Grant Agreement - Jane Smith\",\n \"fileKey\": \"<string>\",\n \"documentDescription\": \"<string>\",\n \"visibleToEmployee\": true,\n \"visibleToClientAdmin\": true,\n \"grantID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.toku.com/api/tokuApi/v1/createDocument")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-role-type"] = '<x-role-type>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentType\": \"GRANT_AGREEMENT\",\n \"documentName\": \"Grant Agreement - Jane Smith\",\n \"fileKey\": \"<string>\",\n \"documentDescription\": \"<string>\",\n \"visibleToEmployee\": true,\n \"visibleToClientAdmin\": true,\n \"grantID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"documentID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}Organization
Create Document
Creates a document record linked to a recipient and optionally a grant.
POST
/
createDocument
Create Document
curl --request POST \
--url https://app.toku.com/api/tokuApi/v1/createDocument \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-role-type: <x-role-type>' \
--data '
{
"roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentType": "GRANT_AGREEMENT",
"documentName": "Grant Agreement - Jane Smith",
"fileKey": "<string>",
"documentDescription": "<string>",
"visibleToEmployee": true,
"visibleToClientAdmin": true,
"grantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://app.toku.com/api/tokuApi/v1/createDocument"
payload = {
"roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentType": "GRANT_AGREEMENT",
"documentName": "Grant Agreement - Jane Smith",
"fileKey": "<string>",
"documentDescription": "<string>",
"visibleToEmployee": True,
"visibleToClientAdmin": True,
"grantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-role-type": "<x-role-type>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-role-type': '<x-role-type>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
roleInOrgID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
documentType: 'GRANT_AGREEMENT',
documentName: 'Grant Agreement - Jane Smith',
fileKey: '<string>',
documentDescription: '<string>',
visibleToEmployee: true,
visibleToClientAdmin: true,
grantID: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://app.toku.com/api/tokuApi/v1/createDocument', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.toku.com/api/tokuApi/v1/createDocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'roleInOrgID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'documentType' => 'GRANT_AGREEMENT',
'documentName' => 'Grant Agreement - Jane Smith',
'fileKey' => '<string>',
'documentDescription' => '<string>',
'visibleToEmployee' => true,
'visibleToClientAdmin' => true,
'grantID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-role-type: <x-role-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.toku.com/api/tokuApi/v1/createDocument"
payload := strings.NewReader("{\n \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentType\": \"GRANT_AGREEMENT\",\n \"documentName\": \"Grant Agreement - Jane Smith\",\n \"fileKey\": \"<string>\",\n \"documentDescription\": \"<string>\",\n \"visibleToEmployee\": true,\n \"visibleToClientAdmin\": true,\n \"grantID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-role-type", "<x-role-type>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.toku.com/api/tokuApi/v1/createDocument")
.header("x-role-type", "<x-role-type>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentType\": \"GRANT_AGREEMENT\",\n \"documentName\": \"Grant Agreement - Jane Smith\",\n \"fileKey\": \"<string>\",\n \"documentDescription\": \"<string>\",\n \"visibleToEmployee\": true,\n \"visibleToClientAdmin\": true,\n \"grantID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.toku.com/api/tokuApi/v1/createDocument")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-role-type"] = '<x-role-type>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentType\": \"GRANT_AGREEMENT\",\n \"documentName\": \"Grant Agreement - Jane Smith\",\n \"fileKey\": \"<string>\",\n \"documentDescription\": \"<string>\",\n \"visibleToEmployee\": true,\n \"visibleToClientAdmin\": true,\n \"grantID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"documentID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}Authorizations
Personal API token. Create via createUserApiToken endpoint.
Headers
Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.
Available options:
CLIENT_ORG_ADMIN, PAYROLL_ADMIN, FINANCE_ADMIN, TOKU_ADMIN Body
application/json
Example:
"GRANT_AGREEMENT"
Example:
"Grant Agreement - Jane Smith"
S3 file key for the uploaded document
Example:
true
Example:
true
Response
Document created
⌘I
