Skip to main content
PUT
/
api
/
projects
/
{id}
Update Project
curl --request PUT \
  --url https://platform.kodexa.ai/api/projects/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "color": "#4A90D9",
  "createdOn": "2023-11-07T05:31:56Z",
  "dataFlow": {
    "edges": [
      {
        "id": "<string>",
        "properties": {},
        "source": "<string>",
        "target": "<string>"
      }
    ],
    "nodes": [
      {
        "dimensions": {
          "height": 123,
          "width": 123
        },
        "id": "<string>",
        "parentId": "<string>",
        "position": {
          "x": 123,
          "y": 123
        },
        "properties": {},
        "type": "<string>"
      }
    ],
    "viewPort": {
      "x": 123,
      "y": 123,
      "zoom": 123
    }
  },
  "description": "Automated invoice processing pipeline.",
  "documentStatuses": [
    {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "<string>",
      "project": "<unknown>",
      "projectId": "<string>",
      "slug": "<string>",
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "memory": {
    "changeSequence": 123,
    "orderedDashboards": [
      "<string>"
    ],
    "recentFilters": {},
    "recentQueries": {}
  },
  "name": "Invoice Processing",
  "notes": "<string>",
  "options": {
    "companion": {
      "agentRuntimeRef": "<string>",
      "moduleRefs": [
        "<string>"
      ],
      "prompt": "<string>"
    },
    "dataOptions": [
      {
        "aliases": [
          "<string>"
        ],
        "default": "<unknown>",
        "description": "<string>",
        "developerOnly": true,
        "displayProperties": {},
        "falseLabel": "<string>",
        "featureFlag": "<string>",
        "groupOptions": "<array>",
        "hint": "<string>",
        "label": "<string>",
        "listDescription": "<string>",
        "listLabel": "<string>",
        "listType": "<string>",
        "name": "<string>",
        "overviewMarkdown": "<string>",
        "possibleValues": [
          {
            "description": "<string>",
            "label": "<string>",
            "value": "<unknown>"
          }
        ],
        "properties": {},
        "required": true,
        "showIf": "<string>",
        "showOnPopup": true,
        "subType": "<string>",
        "supportArticle": "<string>",
        "tabName": "<string>",
        "type": "<string>"
      }
    ],
    "dataProperties": {},
    "executionPolicy": {
      "backoffBaseSeconds": 123,
      "backoffStrategy": "<string>",
      "maxAttempts": 123,
      "onExhausted": "<string>",
      "timeoutSeconds": 123
    },
    "groupTaxonTypeFeatures": {},
    "options": [
      {
        "aliases": [
          "<string>"
        ],
        "default": "<unknown>",
        "description": "<string>",
        "developerOnly": true,
        "displayProperties": {},
        "falseLabel": "<string>",
        "featureFlag": "<string>",
        "groupOptions": "<array>",
        "hint": "<string>",
        "label": "<string>",
        "listDescription": "<string>",
        "listLabel": "<string>",
        "listType": "<string>",
        "name": "<string>",
        "overviewMarkdown": "<string>",
        "possibleValues": [
          {
            "description": "<string>",
            "label": "<string>",
            "value": "<unknown>"
          }
        ],
        "properties": {},
        "required": true,
        "showIf": "<string>",
        "showOnPopup": true,
        "subType": "<string>",
        "supportArticle": "<string>",
        "tabName": "<string>",
        "type": "<string>"
      }
    ],
    "properties": {},
    "taskOptions": {
      "showNewTask": true
    },
    "taxonTypeFeatures": {}
  },
  "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>",
  "owner": {
    "active": true,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "id": "<string>",
    "image": "<string>",
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "security": {
      "roles": [
        "<string>"
      ]
    },
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "ownerId": "<string>",
  "projectTemplateRef": "<string>",
  "searchText": "<string>",
  "slug": "invoice-processing",
  "status": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "icon": "<string>",
    "id": "<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>",
    "production": true,
    "status": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "statusId": "<string>",
  "statusType": "ACTIVE",
  "templateArticleId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "7c9e667974254de944be07fc1f90ae7"
}
'
import requests

url = "https://platform.kodexa.ai/api/projects/{id}"

payload = {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": ["<string>"],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": { "showNewTask": True },
"taxonTypeFeatures": {}
},
"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>",
"owner": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<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>",
"production": True,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
}
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({
changeSequence: 123,
color: '#4A90D9',
createdOn: '2023-11-07T05:31:56Z',
dataFlow: {
edges: [{id: '<string>', properties: {}, source: '<string>', target: '<string>'}],
nodes: [
{
dimensions: {height: 123, width: 123},
id: '<string>',
parentId: '<string>',
position: {x: 123, y: 123},
properties: {},
type: '<string>'
}
],
viewPort: {x: 123, y: 123, zoom: 123}
},
description: 'Automated invoice processing pipeline.',
documentStatuses: [
{
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
project: '<unknown>',
projectId: '<string>',
slug: '<string>',
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
id: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
memory: {
changeSequence: 123,
orderedDashboards: ['<string>'],
recentFilters: {},
recentQueries: {}
},
name: 'Invoice Processing',
notes: '<string>',
options: {
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
dataOptions: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
dataProperties: {},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
groupTaxonTypeFeatures: {},
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
properties: {},
taskOptions: {showNewTask: true},
taxonTypeFeatures: {}
},
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>',
owner: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
ownerId: '<string>',
projectTemplateRef: '<string>',
searchText: '<string>',
slug: 'invoice-processing',
status: {
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<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>',
production: true,
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
statusId: '<string>',
statusType: 'ACTIVE',
templateArticleId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '7c9e667974254de944be07fc1f90ae7'
})
};

fetch('https://platform.kodexa.ai/api/projects/{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/projects/{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([
'changeSequence' => 123,
'color' => '#4A90D9',
'createdOn' => '2023-11-07T05:31:56Z',
'dataFlow' => [
'edges' => [
[
'id' => '<string>',
'properties' => [

],
'source' => '<string>',
'target' => '<string>'
]
],
'nodes' => [
[
'dimensions' => [
'height' => 123,
'width' => 123
],
'id' => '<string>',
'parentId' => '<string>',
'position' => [
'x' => 123,
'y' => 123
],
'properties' => [

],
'type' => '<string>'
]
],
'viewPort' => [
'x' => 123,
'y' => 123,
'zoom' => 123
]
],
'description' => 'Automated invoice processing pipeline.',
'documentStatuses' => [
[
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'project' => '<unknown>',
'projectId' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'memory' => [
'changeSequence' => 123,
'orderedDashboards' => [
'<string>'
],
'recentFilters' => [

],
'recentQueries' => [

]
],
'name' => 'Invoice Processing',
'notes' => '<string>',
'options' => [
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'dataOptions' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [

],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [

],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'dataProperties' => [

],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'groupTaxonTypeFeatures' => [

],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [

],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [

],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'properties' => [

],
'taskOptions' => [
'showNewTask' => true
],
'taxonTypeFeatures' => [

]
],
'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>',
'owner' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'ownerId' => '<string>',
'projectTemplateRef' => '<string>',
'searchText' => '<string>',
'slug' => 'invoice-processing',
'status' => [
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<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>',
'production' => true,
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'statusId' => '<string>',
'statusType' => 'ACTIVE',
'templateArticleId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '7c9e667974254de944be07fc1f90ae7'
]),
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/projects/{id}"

payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\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 \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<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 \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\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/projects/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\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 \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<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 \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/projects/{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 \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\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 \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<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 \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n}"

response = http.request(request)
puts response.read_body
{
  "changeSequence": 123,
  "color": "#4A90D9",
  "createdOn": "2023-11-07T05:31:56Z",
  "dataFlow": {
    "edges": [
      {
        "id": "<string>",
        "properties": {},
        "source": "<string>",
        "target": "<string>"
      }
    ],
    "nodes": [
      {
        "dimensions": {
          "height": 123,
          "width": 123
        },
        "id": "<string>",
        "parentId": "<string>",
        "position": {
          "x": 123,
          "y": 123
        },
        "properties": {},
        "type": "<string>"
      }
    ],
    "viewPort": {
      "x": 123,
      "y": 123,
      "zoom": 123
    }
  },
  "description": "Automated invoice processing pipeline.",
  "documentStatuses": [
    {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "<string>",
      "project": "<unknown>",
      "projectId": "<string>",
      "slug": "<string>",
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "memory": {
    "changeSequence": 123,
    "orderedDashboards": [
      "<string>"
    ],
    "recentFilters": {},
    "recentQueries": {}
  },
  "name": "Invoice Processing",
  "notes": "<string>",
  "options": {
    "companion": {
      "agentRuntimeRef": "<string>",
      "moduleRefs": [
        "<string>"
      ],
      "prompt": "<string>"
    },
    "dataOptions": [
      {
        "aliases": [
          "<string>"
        ],
        "default": "<unknown>",
        "description": "<string>",
        "developerOnly": true,
        "displayProperties": {},
        "falseLabel": "<string>",
        "featureFlag": "<string>",
        "groupOptions": "<array>",
        "hint": "<string>",
        "label": "<string>",
        "listDescription": "<string>",
        "listLabel": "<string>",
        "listType": "<string>",
        "name": "<string>",
        "overviewMarkdown": "<string>",
        "possibleValues": [
          {
            "description": "<string>",
            "label": "<string>",
            "value": "<unknown>"
          }
        ],
        "properties": {},
        "required": true,
        "showIf": "<string>",
        "showOnPopup": true,
        "subType": "<string>",
        "supportArticle": "<string>",
        "tabName": "<string>",
        "type": "<string>"
      }
    ],
    "dataProperties": {},
    "executionPolicy": {
      "backoffBaseSeconds": 123,
      "backoffStrategy": "<string>",
      "maxAttempts": 123,
      "onExhausted": "<string>",
      "timeoutSeconds": 123
    },
    "groupTaxonTypeFeatures": {},
    "options": [
      {
        "aliases": [
          "<string>"
        ],
        "default": "<unknown>",
        "description": "<string>",
        "developerOnly": true,
        "displayProperties": {},
        "falseLabel": "<string>",
        "featureFlag": "<string>",
        "groupOptions": "<array>",
        "hint": "<string>",
        "label": "<string>",
        "listDescription": "<string>",
        "listLabel": "<string>",
        "listType": "<string>",
        "name": "<string>",
        "overviewMarkdown": "<string>",
        "possibleValues": [
          {
            "description": "<string>",
            "label": "<string>",
            "value": "<unknown>"
          }
        ],
        "properties": {},
        "required": true,
        "showIf": "<string>",
        "showOnPopup": true,
        "subType": "<string>",
        "supportArticle": "<string>",
        "tabName": "<string>",
        "type": "<string>"
      }
    ],
    "properties": {},
    "taskOptions": {
      "showNewTask": true
    },
    "taxonTypeFeatures": {}
  },
  "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>",
  "owner": {
    "active": true,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "id": "<string>",
    "image": "<string>",
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "security": {
      "roles": [
        "<string>"
      ]
    },
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "ownerId": "<string>",
  "projectTemplateRef": "<string>",
  "searchText": "<string>",
  "slug": "invoice-processing",
  "status": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "icon": "<string>",
    "id": "<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>",
    "production": true,
    "status": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "statusId": "<string>",
  "statusType": "ACTIVE",
  "templateArticleId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "7c9e667974254de944be07fc1f90ae7"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

changeSequence
integer<int32>

Optimistic locking version number.

color
string

Display color for the project (max 25 characters).

Example:

"#4A90D9"

createdOn
string<date-time>

Timestamp when the project was created.

dataFlow
object

Project data flow configuration.

description
string

Human-readable description of the project.

Example:

"Automated invoice processing pipeline."

documentStatuses
object[]
id
string

Unique identifier (UUID) for the project.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

memory
object

Project-level memory and configuration.

name
string

Display name of the project.

Example:

"Invoice Processing"

notes
string

Free-form notes about the project.

options
object

Project options and settings.

organization
object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

organizationId
string | null

ID of the organization this project belongs to.

owner
object | null

A platform user represents a user account in the Kodexa platform.

ownerId
string | null

ID of the user who owns this project.

projectTemplateRef
string

Reference to the project template used to create this project.

searchText
string
slug
string

URL-friendly identifier. Automatically lowercased. Pattern: ^[a-z0-9-]+$

Example:

"invoice-processing"

status
object | null

A project status defines a named state for tracking project lifecycle.

statusId
string | null

ID of the current project status.

statusType
string

Project lifecycle state: ACTIVE, ARCHIVED, or PENDING_DELETE.

Example:

"ACTIVE"

templateArticleId
string
updatedOn
string<date-time>

Timestamp when the project was last updated.

uuid
string

Secondary UUID identifier.

Example:

"7c9e667974254de944be07fc1f90ae7"

Response

Updated Project

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

changeSequence
integer<int32>

Optimistic locking version number.

color
string

Display color for the project (max 25 characters).

Example:

"#4A90D9"

createdOn
string<date-time>

Timestamp when the project was created.

dataFlow
object

Project data flow configuration.

description
string

Human-readable description of the project.

Example:

"Automated invoice processing pipeline."

documentStatuses
object[]
id
string

Unique identifier (UUID) for the project.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

memory
object

Project-level memory and configuration.

name
string

Display name of the project.

Example:

"Invoice Processing"

notes
string

Free-form notes about the project.

options
object

Project options and settings.

organization
object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

organizationId
string | null

ID of the organization this project belongs to.

owner
object | null

A platform user represents a user account in the Kodexa platform.

ownerId
string | null

ID of the user who owns this project.

projectTemplateRef
string

Reference to the project template used to create this project.

searchText
string
slug
string

URL-friendly identifier. Automatically lowercased. Pattern: ^[a-z0-9-]+$

Example:

"invoice-processing"

status
object | null

A project status defines a named state for tracking project lifecycle.

statusId
string | null

ID of the current project status.

statusType
string

Project lifecycle state: ACTIVE, ARCHIVED, or PENDING_DELETE.

Example:

"ACTIVE"

templateArticleId
string
updatedOn
string<date-time>

Timestamp when the project was last updated.

uuid
string

Secondary UUID identifier.

Example:

"7c9e667974254de944be07fc1f90ae7"