Update organization document types
curl --request PUT \
--url https://your-instance.example.com/api/organizations/{organizationId}/document-types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documentTypes": [
{
"name": "Credit Bureau",
"isRequired": true
},
{
"name": "Paystub",
"isRequired": true
}
]
}
'import requests
url = "https://your-instance.example.com/api/organizations/{organizationId}/document-types"
payload = { "documentTypes": [
{
"name": "Credit Bureau",
"isRequired": True
},
{
"name": "Paystub",
"isRequired": True
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documentTypes: [{name: 'Credit Bureau', isRequired: true}, {name: 'Paystub', isRequired: true}]
})
};
fetch('https://your-instance.example.com/api/organizations/{organizationId}/document-types', 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://your-instance.example.com/api/organizations/{organizationId}/document-types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'documentTypes' => [
[
'name' => 'Credit Bureau',
'isRequired' => true
],
[
'name' => 'Paystub',
'isRequired' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://your-instance.example.com/api/organizations/{organizationId}/document-types"
payload := strings.NewReader("{\n \"documentTypes\": [\n {\n \"name\": \"Credit Bureau\",\n \"isRequired\": true\n },\n {\n \"name\": \"Paystub\",\n \"isRequired\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://your-instance.example.com/api/organizations/{organizationId}/document-types")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documentTypes\": [\n {\n \"name\": \"Credit Bureau\",\n \"isRequired\": true\n },\n {\n \"name\": \"Paystub\",\n \"isRequired\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/organizations/{organizationId}/document-types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentTypes\": [\n {\n \"name\": \"Credit Bureau\",\n \"isRequired\": true\n },\n {\n \"name\": \"Paystub\",\n \"isRequired\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"documentTypes": [
{
"name": "Credit Bureau",
"isRequired": true
},
{
"name": "Paystub",
"isRequired": true
}
]
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}Organizations
Update organization document types
Replaces the list of document types for the organization. Each entry requires a non-empty name; names must be unique (case-insensitive). Admin can update own org; SuperAdmin can update any org.
PUT
/
api
/
organizations
/
{organizationId}
/
document-types
Update organization document types
curl --request PUT \
--url https://your-instance.example.com/api/organizations/{organizationId}/document-types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documentTypes": [
{
"name": "Credit Bureau",
"isRequired": true
},
{
"name": "Paystub",
"isRequired": true
}
]
}
'import requests
url = "https://your-instance.example.com/api/organizations/{organizationId}/document-types"
payload = { "documentTypes": [
{
"name": "Credit Bureau",
"isRequired": True
},
{
"name": "Paystub",
"isRequired": True
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documentTypes: [{name: 'Credit Bureau', isRequired: true}, {name: 'Paystub', isRequired: true}]
})
};
fetch('https://your-instance.example.com/api/organizations/{organizationId}/document-types', 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://your-instance.example.com/api/organizations/{organizationId}/document-types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'documentTypes' => [
[
'name' => 'Credit Bureau',
'isRequired' => true
],
[
'name' => 'Paystub',
'isRequired' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://your-instance.example.com/api/organizations/{organizationId}/document-types"
payload := strings.NewReader("{\n \"documentTypes\": [\n {\n \"name\": \"Credit Bureau\",\n \"isRequired\": true\n },\n {\n \"name\": \"Paystub\",\n \"isRequired\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://your-instance.example.com/api/organizations/{organizationId}/document-types")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documentTypes\": [\n {\n \"name\": \"Credit Bureau\",\n \"isRequired\": true\n },\n {\n \"name\": \"Paystub\",\n \"isRequired\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/organizations/{organizationId}/document-types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentTypes\": [\n {\n \"name\": \"Credit Bureau\",\n \"isRequired\": true\n },\n {\n \"name\": \"Paystub\",\n \"isRequired\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"documentTypes": [
{
"name": "Credit Bureau",
"isRequired": true
},
{
"name": "Paystub",
"isRequired": true
}
]
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}{
"error": "Organization not found",
"details": "No organization exists with the provided id"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Full replacement list of document types the organization collects from contacts; each entry carries a name, required flag, and optional description.
Show child attributes
Show child attributes
⌘I