Update Intake
curl --request PUT \
--url https://platform.kodexa.ai/api/intakes/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"active": true,
"activityPlanId": "<string>",
"allowMultipleFiles": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"knowledgeFeatureIds": {},
"largeUploadEnabled": true,
"metadata": {},
"name": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"script": "<string>",
"scriptEnabled": true,
"slug": "<string>",
"store": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": true,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"deleteProtection": true,
"metadata": {
"documentProperties": "<unknown>",
"indexed": true,
"labelExpressions": "<unknown>",
"type": "<string>"
},
"storePurpose": "<string>",
"storeType": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/intakes/{id}"
payload = {
"active": True,
"activityPlanId": "<string>",
"allowMultipleFiles": True,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"knowledgeFeatureIds": {},
"largeUploadEnabled": True,
"metadata": {},
"name": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"script": "<string>",
"scriptEnabled": True,
"slug": "<string>",
"store": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": True,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": True,
"eventAware": True,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"deleteProtection": True,
"metadata": {
"documentProperties": "<unknown>",
"indexed": True,
"labelExpressions": "<unknown>",
"type": "<string>"
},
"storePurpose": "<string>",
"storeType": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": True,
"slug": "<string>",
"supportsScheduling": True,
"template": True,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
activityPlanId: '<string>',
allowMultipleFiles: true,
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
id: '<string>',
knowledgeFeatureIds: {},
largeUploadEnabled: true,
metadata: {},
name: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
script: '<string>',
scriptEnabled: true,
slug: '<string>',
store: {
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deleteUserEmail: '<string>',
deleteUserId: '<string>',
deleted: true,
deletedDate: '2023-11-07T05:31:56Z',
deprecated: true,
eventAware: true,
extensionPackRef: '<string>',
id: '<string>',
metadata: {
deleteProtection: true,
metadata: {
documentProperties: '<unknown>',
indexed: true,
labelExpressions: '<unknown>',
type: '<string>'
},
storePurpose: '<string>',
storeType: '<string>'
},
name: '<string>',
organizationId: '<string>',
publicAccess: true,
slug: '<string>',
supportsScheduling: true,
template: true,
type: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>',
yamlSource: '<string>'
},
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/intakes/{id}', 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://platform.kodexa.ai/api/intakes/{id}",
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([
'active' => true,
'activityPlanId' => '<string>',
'allowMultipleFiles' => true,
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'id' => '<string>',
'knowledgeFeatureIds' => [
],
'largeUploadEnabled' => true,
'metadata' => [
],
'name' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'script' => '<string>',
'scriptEnabled' => true,
'slug' => '<string>',
'store' => [
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deleteUserEmail' => '<string>',
'deleteUserId' => '<string>',
'deleted' => true,
'deletedDate' => '2023-11-07T05:31:56Z',
'deprecated' => true,
'eventAware' => true,
'extensionPackRef' => '<string>',
'id' => '<string>',
'metadata' => [
'deleteProtection' => true,
'metadata' => [
'documentProperties' => '<unknown>',
'indexed' => true,
'labelExpressions' => '<unknown>',
'type' => '<string>'
],
'storePurpose' => '<string>',
'storeType' => '<string>'
],
'name' => '<string>',
'organizationId' => '<string>',
'publicAccess' => true,
'slug' => '<string>',
'supportsScheduling' => true,
'template' => true,
'type' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>',
'yamlSource' => '<string>'
],
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://platform.kodexa.ai/api/intakes/{id}"
payload := strings.NewReader("{\n \"active\": true,\n \"activityPlanId\": \"<string>\",\n \"allowMultipleFiles\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"knowledgeFeatureIds\": {},\n \"largeUploadEnabled\": true,\n \"metadata\": {},\n \"name\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"script\": \"<string>\",\n \"scriptEnabled\": true,\n \"slug\": \"<string>\",\n \"store\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"eventAware\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"metadata\": {\n \"deleteProtection\": true,\n \"metadata\": {\n \"documentProperties\": \"<unknown>\",\n \"indexed\": true,\n \"labelExpressions\": \"<unknown>\",\n \"type\": \"<string>\"\n },\n \"storePurpose\": \"<string>\",\n \"storeType\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"<string>\",\n \"supportsScheduling\": true,\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://platform.kodexa.ai/api/intakes/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"activityPlanId\": \"<string>\",\n \"allowMultipleFiles\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"knowledgeFeatureIds\": {},\n \"largeUploadEnabled\": true,\n \"metadata\": {},\n \"name\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"script\": \"<string>\",\n \"scriptEnabled\": true,\n \"slug\": \"<string>\",\n \"store\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"eventAware\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"metadata\": {\n \"deleteProtection\": true,\n \"metadata\": {\n \"documentProperties\": \"<unknown>\",\n \"indexed\": true,\n \"labelExpressions\": \"<unknown>\",\n \"type\": \"<string>\"\n },\n \"storePurpose\": \"<string>\",\n \"storeType\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"<string>\",\n \"supportsScheduling\": true,\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/intakes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"activityPlanId\": \"<string>\",\n \"allowMultipleFiles\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"knowledgeFeatureIds\": {},\n \"largeUploadEnabled\": true,\n \"metadata\": {},\n \"name\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"script\": \"<string>\",\n \"scriptEnabled\": true,\n \"slug\": \"<string>\",\n \"store\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"eventAware\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"metadata\": {\n \"deleteProtection\": true,\n \"metadata\": {\n \"documentProperties\": \"<unknown>\",\n \"indexed\": true,\n \"labelExpressions\": \"<unknown>\",\n \"type\": \"<string>\"\n },\n \"storePurpose\": \"<string>\",\n \"storeType\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"<string>\",\n \"supportsScheduling\": true,\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"activityPlanId": "<string>",
"allowMultipleFiles": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"knowledgeFeatureIds": {},
"largeUploadEnabled": true,
"metadata": {},
"name": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"script": "<string>",
"scriptEnabled": true,
"slug": "<string>",
"store": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": true,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"deleteProtection": true,
"metadata": {
"documentProperties": "<unknown>",
"indexed": true,
"labelExpressions": "<unknown>",
"type": "<string>"
},
"storePurpose": "<string>",
"storeType": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Intakes
Update Intake
Updates an existing Intake. Intakes configure how documents are ingested from external sources.
PUT
/
api
/
intakes
/
{id}
Update Intake
curl --request PUT \
--url https://platform.kodexa.ai/api/intakes/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"active": true,
"activityPlanId": "<string>",
"allowMultipleFiles": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"knowledgeFeatureIds": {},
"largeUploadEnabled": true,
"metadata": {},
"name": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"script": "<string>",
"scriptEnabled": true,
"slug": "<string>",
"store": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": true,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"deleteProtection": true,
"metadata": {
"documentProperties": "<unknown>",
"indexed": true,
"labelExpressions": "<unknown>",
"type": "<string>"
},
"storePurpose": "<string>",
"storeType": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/intakes/{id}"
payload = {
"active": True,
"activityPlanId": "<string>",
"allowMultipleFiles": True,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"knowledgeFeatureIds": {},
"largeUploadEnabled": True,
"metadata": {},
"name": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"script": "<string>",
"scriptEnabled": True,
"slug": "<string>",
"store": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": True,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": True,
"eventAware": True,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"deleteProtection": True,
"metadata": {
"documentProperties": "<unknown>",
"indexed": True,
"labelExpressions": "<unknown>",
"type": "<string>"
},
"storePurpose": "<string>",
"storeType": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": True,
"slug": "<string>",
"supportsScheduling": True,
"template": True,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
activityPlanId: '<string>',
allowMultipleFiles: true,
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
id: '<string>',
knowledgeFeatureIds: {},
largeUploadEnabled: true,
metadata: {},
name: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
script: '<string>',
scriptEnabled: true,
slug: '<string>',
store: {
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deleteUserEmail: '<string>',
deleteUserId: '<string>',
deleted: true,
deletedDate: '2023-11-07T05:31:56Z',
deprecated: true,
eventAware: true,
extensionPackRef: '<string>',
id: '<string>',
metadata: {
deleteProtection: true,
metadata: {
documentProperties: '<unknown>',
indexed: true,
labelExpressions: '<unknown>',
type: '<string>'
},
storePurpose: '<string>',
storeType: '<string>'
},
name: '<string>',
organizationId: '<string>',
publicAccess: true,
slug: '<string>',
supportsScheduling: true,
template: true,
type: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>',
yamlSource: '<string>'
},
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/intakes/{id}', 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://platform.kodexa.ai/api/intakes/{id}",
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([
'active' => true,
'activityPlanId' => '<string>',
'allowMultipleFiles' => true,
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'id' => '<string>',
'knowledgeFeatureIds' => [
],
'largeUploadEnabled' => true,
'metadata' => [
],
'name' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'script' => '<string>',
'scriptEnabled' => true,
'slug' => '<string>',
'store' => [
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deleteUserEmail' => '<string>',
'deleteUserId' => '<string>',
'deleted' => true,
'deletedDate' => '2023-11-07T05:31:56Z',
'deprecated' => true,
'eventAware' => true,
'extensionPackRef' => '<string>',
'id' => '<string>',
'metadata' => [
'deleteProtection' => true,
'metadata' => [
'documentProperties' => '<unknown>',
'indexed' => true,
'labelExpressions' => '<unknown>',
'type' => '<string>'
],
'storePurpose' => '<string>',
'storeType' => '<string>'
],
'name' => '<string>',
'organizationId' => '<string>',
'publicAccess' => true,
'slug' => '<string>',
'supportsScheduling' => true,
'template' => true,
'type' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>',
'yamlSource' => '<string>'
],
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://platform.kodexa.ai/api/intakes/{id}"
payload := strings.NewReader("{\n \"active\": true,\n \"activityPlanId\": \"<string>\",\n \"allowMultipleFiles\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"knowledgeFeatureIds\": {},\n \"largeUploadEnabled\": true,\n \"metadata\": {},\n \"name\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"script\": \"<string>\",\n \"scriptEnabled\": true,\n \"slug\": \"<string>\",\n \"store\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"eventAware\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"metadata\": {\n \"deleteProtection\": true,\n \"metadata\": {\n \"documentProperties\": \"<unknown>\",\n \"indexed\": true,\n \"labelExpressions\": \"<unknown>\",\n \"type\": \"<string>\"\n },\n \"storePurpose\": \"<string>\",\n \"storeType\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"<string>\",\n \"supportsScheduling\": true,\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://platform.kodexa.ai/api/intakes/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"activityPlanId\": \"<string>\",\n \"allowMultipleFiles\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"knowledgeFeatureIds\": {},\n \"largeUploadEnabled\": true,\n \"metadata\": {},\n \"name\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"script\": \"<string>\",\n \"scriptEnabled\": true,\n \"slug\": \"<string>\",\n \"store\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"eventAware\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"metadata\": {\n \"deleteProtection\": true,\n \"metadata\": {\n \"documentProperties\": \"<unknown>\",\n \"indexed\": true,\n \"labelExpressions\": \"<unknown>\",\n \"type\": \"<string>\"\n },\n \"storePurpose\": \"<string>\",\n \"storeType\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"<string>\",\n \"supportsScheduling\": true,\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/intakes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"activityPlanId\": \"<string>\",\n \"allowMultipleFiles\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"knowledgeFeatureIds\": {},\n \"largeUploadEnabled\": true,\n \"metadata\": {},\n \"name\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"script\": \"<string>\",\n \"scriptEnabled\": true,\n \"slug\": \"<string>\",\n \"store\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"eventAware\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"metadata\": {\n \"deleteProtection\": true,\n \"metadata\": {\n \"documentProperties\": \"<unknown>\",\n \"indexed\": true,\n \"labelExpressions\": \"<unknown>\",\n \"type\": \"<string>\"\n },\n \"storePurpose\": \"<string>\",\n \"storeType\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"<string>\",\n \"supportsScheduling\": true,\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"activityPlanId": "<string>",
"allowMultipleFiles": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"knowledgeFeatureIds": {},
"largeUploadEnabled": true,
"metadata": {},
"name": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"script": "<string>",
"scriptEnabled": true,
"slug": "<string>",
"store": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": true,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"deleteProtection": true,
"metadata": {
"documentProperties": "<unknown>",
"indexed": true,
"labelExpressions": "<unknown>",
"type": "<string>"
},
"storePurpose": "<string>",
"storeType": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
application/json
An intake configures how documents are ingested from external sources.
Show child attributes
Show child attributes
An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Updated Intake
An intake configures how documents are ingested from external sources.
Show child attributes
Show child attributes
An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I