Skip to main content
PUT
/
api
/
sessions
/
{id}
Update Session
curl --request PUT \
  --url https://platform.kodexa.ai/api/sessions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "<string>",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "<string>",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "<string>",
    "organizationStatus": "<string>",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "<string>",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "state": "<string>",
  "token": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "<string>",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "<string>",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "<string>",
    "organizationStatus": "<string>",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "<string>",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "state": "<string>",
  "token": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

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 session represents a processing session for document operations.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the session was created.

​
id
string

Unique identifier (UUID) for the session.

​
organization
object
​
organizationId
string | null
​
state
string
​
token
string
​
updatedOn
string<date-time>

Timestamp when the session was last updated.

​
uuid
string

Secondary UUID identifier.

Response

Updated Session

A session represents a processing session for document operations.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the session was created.

​
id
string

Unique identifier (UUID) for the session.

​
organization
object
​
organizationId
string | null
​
state
string
​
token
string
​
updatedOn
string<date-time>

Timestamp when the session was last updated.

​
uuid
string

Secondary UUID identifier.