Update a Record

PATCH

apps

{app_id}

collections

{collection_id}

records

{record_id}

curl --request PATCH \
  --url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id}/records/{record_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "New Important Record",
  "rules": {},
  "run": "changed",
  "tags_ids": [
    "tag_xxx",
    "tag_yyy"
  ]
}'

{
  "id": "<string>",
  "name": "Important Record",
  "status": "COMPLETED",
  "source": "API",
  "usage": {
    "total": 123,
    "calls": [
      {
        "id": "<string>",
        "total": 123,
        "calls": [
          {}
        ]
      }
    ],
    "rules": {}
  },
  "rules_count": 123,
  "rules_pass_count": 123,
  "rules_fail_count": 123,
  "rules_warn_count": 123,
  "rules": {},
  "collection_name": "<string>",
  "collection_id": "col_xxx",
  "created_by": {
    "id": "user_xxx",
    "name": "John Doe"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "config": {
    "id": "<string>",
    "mappings": [
      {
        "source_path": "LOAN_APPLICATION:income",
        "destination_paths": [
          "MONTHLY_INCOME:amount",
          "ANNUAL_INCOME:amount"
        ]
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "rules": [
      {
        "name": "Check Business Name",
        "key": "CHECK_BUSINESS_NAME",
        "execution_order": "before-all",
        "on_success": "PASS",
        "on_fail": "WARN",
        "step_key": "<string>",
        "workflow_id": "work_xxx",
        "workflow_version_id": "workv_xxx",
        "workflow_use_latest": true,
        "workflow_input_default": {
          "business_name": "Example Corp"
        },
        "disabled": false,
        "workflow": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "app": {
            "id": "<string>",
            "name": "<string>",
            "verified": true
          },
          "version": {
            "id": "<string>",
            "app_id": "<string>",
            "workflow_id": "<string>",
            "description": "<string>",
            "version": 123,
            "rollback_version": 123,
            "notes": "<string>",
            "created_by": {
              "id": "<string>",
              "name": "<string>"
            },
            "created_at": "2023-12-25",
            "key": "<string>",
            "input": {},
            "input_default": {},
            "input_options": {
              "display": {
                "field": "inline",
                "container": "grid",
                "hidden": true
              }
            },
            "steps": [
              {
                "type": "note",
                "key": "<string>",
                "conditional": "<string>",
                "loop": "<string>",
                "throw_on_error": true,
                "input_connected": true,
                "destinations": [
                  "<string>"
                ],
                "position": [
                  123
                ],
                "size": [
                  101
                ],
                "auto": {
                  "provider": "<string>",
                  "model": "<string>",
                  "temperature": 1
                },
                "note": "<string>"
              }
            ]
          },
          "tags": [
            {
              "id": "<string>",
              "name": "<string>",
              "color": "<string>",
              "app_id": "<string>",
              "created_at": "2023-12-25",
              "updated_at": "2023-12-25"
            }
          ],
          "tests_stats": {
            "total_count": 123,
            "running_count": 123,
            "cancelled_count": 123,
            "passing_count": 123,
            "failing_count": 123,
            "expectations_failing_count": 123,
            "expectations_passing_count": 123
          },
          "template_id": "<string>",
          "runs_count": 0,
          "enabled": true,
          "deleted": false,
          "created_at": "2023-12-25",
          "updated_at": "2023-12-25",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "input_options": {
            "display": {
              "field": "inline",
              "container": "grid",
              "hidden": true
            }
          },
          "steps": [
            {
              "type": "note",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "throw_on_error": true,
              "input_connected": true,
              "destinations": [
                "<string>"
              ],
              "position": [
                123
              ],
              "size": [
                101
              ],
              "auto": {
                "provider": "<string>",
                "model": "<string>",
                "temperature": 1
              },
              "note": "<string>"
            }
          ]
        },
        "workflow_version": {
          "id": "<string>",
          "app_id": "<string>",
          "workflow_id": "<string>",
          "description": "<string>",
          "version": 123,
          "rollback_version": 123,
          "notes": "<string>",
          "created_by": {
            "id": "<string>",
            "name": "<string>"
          },
          "created_at": "2023-12-25",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "input_options": {
            "display": {
              "field": "inline",
              "container": "grid",
              "hidden": true
            }
          },
          "steps": [
            {
              "type": "note",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "throw_on_error": true,
              "input_connected": true,
              "destinations": [
                "<string>"
              ],
              "position": [
                123
              ],
              "size": [
                101
              ],
              "auto": {
                "provider": "<string>",
                "model": "<string>",
                "temperature": 1
              },
              "note": "<string>"
            }
          ]
        }
      }
    ]
  },
  "entity": {
    "id": "<string>",
    "entity_id": "<string>",
    "status": "SYNCED",
    "type": "ENCOMPASS",
    "trigger_id": "<string>",
    "record_id": "<string>",
    "data": {},
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  }
}

Path Parameters

app_id

string

required

The ID of the app

collection_id

string

required

The ID of the collection

record_id

string

required

The ID of the record

Query Parameters

verbose

enum<string>[]

Properties to include in the record response

Available options:

all

Example:

["all"]

Body

Provide the changes you want to make to the record.

name

string | null

Name of the record (up to 128 characters)

Required string length: 1 - 128

Example:

"New Important Record"

rules

object

The rules to be applied to the record

run

enum<string>

When running the record, specify whether all rules should be executed or only the changed ones

Available options:

all,

changed

Example:

"changed"

tags_ids

string[]

Tags to associate with the record (up to 20)

Example:

["tag_xxx", "tag_yyy"]

Response

200 - application/json

You will receive the updated record details.

Detailed information about a record with the details of the trigger entity and collection configuration

string

required

Unique identifier for the record

name

string | null

required

Name of the record

Example:

"Important Record"

status

enum<string>

required

Current status of the record

Available options:

DRAFT,

QUEUED,

RUNNING,

CANCELLED,

COMPLETED,

FAILED

Example:

"COMPLETED"

source

enum<string>

required

Source from which the record was created

Available options:

APP,

API,

TRIGGER

Example:

"API"

rules_count

number

required

Total number of rules of this record

rules_pass_count

number

required

Number of passed rules

rules_fail_count

number

required

Number of failed rules

rules_warn_count

number

required

Number of rules with warnings

rules

object

required

Rules associated with this record

rules.{key}

object

Detailed information about a record rule

rules.{key}.status

enum<string>

required

Current status of the record rule

Available options:

DRAFT,

RUNNING,

PASSED,

FAILED,

WARN

Example:

"PASSED"

rules.{key}.key

string

required

Unique key of the rule within the collection

Example:

"CHECK_BUSINESS_NAME"

rules.{key}.input

object | null

required

Input values used for the rule execution

Example:

{ "business_name": "Acme Corp" }

rules.{key}.run

object | null

required

Details of the rule execution workflow run

rules.{key}.run.id

string

required

Unique identifier for the run

rules.{key}.run.input

object | null

required

Input values used for the run

rules.{key}.run.output

object

required

Output of the run

rules.{key}.run.status

enum<string>

required

Status of the run

Available options:

PENDING,

RUNNING,

CANCELLED,

COMPLETED,

SKIPPED,

FAILED

Example:

"RUNNING"

rules.{key}.run.origin

enum<string>

required

Origin of the run

Available options:

WORKFLOW,

TRIGGER,

RECORD,

TEST,

ENDPOINT

Example:

"WORKFLOW"

rules.{key}.run.started_at

string | null

required

Timestamp of when the run started

rules.{key}.run.ended_at

string | null

required

Timestamp of when the run ended

rules.{key}.run.app_id

string

required

ID of the associated app where the run was triggered from

rules.{key}.run.workflow_app_id

string

required

ID of the associated app where the workflow belongs to

rules.{key}.run.workflow_id

string

required

ID of the associated workflow

rules.{key}.run.workflow_version_draft

object | null

required

Draft version of the workflow

rules.{key}.run.workflow_version

object | null

required

Details of the workflow version used for the run

rules.{key}.run.created_at

string | null

required

Timestamp of when the run was created

rules.{key}.run.updated_at

string | null

required

Timestamp of when the run was last updated

rules.{key}.run.result

any | null

Result of the run

rules.{key}.run.error

string

Error message if the run failed

rules.{key}.run.collection_id

string

ID of the associated collection

rules.{key}.run.record_id

string

ID of the associated record

rules.{key}.run.version

number

Version number of the workflow

rules.{key}.run.usage

object

Credits usage of the run

rules.{key}.created_at

string | null

required

Timestamp when the record rule was created

rules.{key}.updated_at

string | null

required

Timestamp when the record rule was last updated

rules.{key}.verbose

enum<string>[]

Available options:

all

rules.{key}.result

any | null

Result of the rule execution

rules.{key}.error

string

Error message if the rule execution failed

Example:

"Invalid input data"

collection_name

string

required

Name of the collection this record belongs to

collection_id

string

required

Unique identifier of the collection this record belongs to

Example:

"col_xxx"

created_by

object

required

User who created this record

Example:

{ "id": "user_xxx", "name": "John Doe" }

tags

object[]

required

Tags associated with this record

Detailed information about an app tag (which can be attached to records, workflows, etc.)

created_at

string | null

required

Timestamp when the record was created

updated_at

string | null

required

Timestamp when the record was last updated

config

object

required

config.id

string

required

Unique identifier for the collection configuration

config.mappings

object[]

required

List of input field mappings of the collection

Mapping of a source field to multiple destination fields

config.mappings.source_path

string

required

Path to the source input field

Example:

"LOAN_APPLICATION:income"

config.mappings.destination_paths

string[]

required

Paths to the destination input fields to map to

Example:

[
  "MONTHLY_INCOME:amount",
  "ANNUAL_INCOME:amount"
]

config.created_at

string | null

required

Timestamp when the configuration was created

config.updated_at

string | null

required

Timestamp when the configuration was last updated

config.rules

object[]

required

List of rules associated with the collection with workflow details

Detailed information about a rule with workflow details

config.rules.name

string

required

Name of the rule

Example:

"Check Business Name"

config.rules.key

string

required

Unique key of the rule within the collection

Example:

"CHECK_BUSINESS_NAME"

config.rules.on_success

enum<string>

required

Action to take if the rule passes

Available options:

PASS,

FAIL,

WARN

Example:

"PASS"

config.rules.on_fail

enum<string>

required

Action to take if the rule fails

Available options:

PASS,

FAIL,

WARN

Example:

"WARN"

config.rules.workflow_id

string

required

Unique identifier of the linked workflow

Example:

"work_xxx"

config.rules.workflow_version_id

string

required

Unique identifier of the specific workflow version to use

Example:

"workv_xxx"

config.rules.workflow_use_latest

boolean

required

Should the rule use the latest version of the workflow?

Example:

true

config.rules.workflow

object

required

Detailed information about a workflow

config.rules.workflow.id

string

required

Unique identifier for the workflow

config.rules.workflow.name

string

required

Name of the workflow

config.rules.workflow.description

string | null

required

Description of the workflow

config.rules.workflow.app

object

required

Associated app with the workflow

config.rules.workflow.version

object | null

required

Current version of the workflow

config.rules.workflow.tags

object[]

required

Tags associated with the workflow

Detailed information about an app tag (which can be attached to records, workflows, etc.)

config.rules.workflow.template_id

string | null

required

Unique identifier for the template

config.rules.workflow.runs_count

number

required

Number of runs of the workflow

Example:

0

config.rules.workflow.enabled

boolean

required

Indicates if the workflow is enabled

Example:

true

config.rules.workflow.deleted

boolean

required

Indicates if the workflow is deleted

Example:

false

config.rules.workflow.created_at

string | null

required

Creation date of the workflow

config.rules.workflow.updated_at

string | null

required

Last update date of the workflow

config.rules.workflow.key

string

required

Unique key for the workflow version

config.rules.workflow.input

object

required

Input definition of the workflow

config.rules.workflow.input_default

object | null

required

Default config input values of the workflow

config.rules.workflow.input_options

object | null

required

Input options of the workflow

config.rules.workflow.steps

object[]

required

Steps of the workflow at the time this version was deployed

A step that displays as a note on the canvas

config.rules.workflow.tests_stats

object | null

Statistics of the workflow tests

config.rules.workflow_version

object

required

Information about the workflow version

config.rules.workflow_version.id

string

required

Unique identifier for the workflow version

config.rules.workflow_version.app_id

string

required

App id where the workflow version belongs to

config.rules.workflow_version.workflow_id

string

required

Workflow id where the version belongs to

config.rules.workflow_version.description

string | null

required

Description of the workflow at the time this version was deployed

config.rules.workflow_version.version

number

required

Version number

config.rules.workflow_version.notes

string | null

required

Release notes

config.rules.workflow_version.created_at

string | null

required

Date when the version was deployed

config.rules.workflow_version.key

string

required

Unique key for the workflow version

config.rules.workflow_version.input

object

required

Input definition of the workflow

config.rules.workflow_version.input_default

object | null

required

Default config input values of the workflow

config.rules.workflow_version.input_options

object | null

required

Input options of the workflow

config.rules.workflow_version.steps

object[]

required

Steps of the workflow at the time this version was deployed

A step that displays as a note on the canvas

config.rules.workflow_version.rollback_version

number

Version number from which this version was rolled back

config.rules.workflow_version.created_by

object

User who deployed the version

config.rules.execution_order

string

When to run this rule compared to others

Example:

"before-all"

config.rules.step_key

string | null

Step key to run the rule on

config.rules.workflow_input_default

object | null

Default config input values to execute the workflow with

Example:

{ "business_name": "Example Corp" }

config.rules.disabled

boolean

Whether the rule is disabled

Example:

false

entity

object | null

required

Detailed information about a trigger entity

usage

object

Credit usage information of the record

Was this page helpful?

Raise issue

Delete a Record Get Record Status

curl --request PATCH \
  --url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id}/records/{record_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "New Important Record",
  "rules": {},
  "run": "changed",
  "tags_ids": [
    "tag_xxx",
    "tag_yyy"
  ]
}'

{
  "id": "<string>",
  "name": "Important Record",
  "status": "COMPLETED",
  "source": "API",
  "usage": {
    "total": 123,
    "calls": [
      {
        "id": "<string>",
        "total": 123,
        "calls": [
          {}
        ]
      }
    ],
    "rules": {}
  },
  "rules_count": 123,
  "rules_pass_count": 123,
  "rules_fail_count": 123,
  "rules_warn_count": 123,
  "rules": {},
  "collection_name": "<string>",
  "collection_id": "col_xxx",
  "created_by": {
    "id": "user_xxx",
    "name": "John Doe"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "config": {
    "id": "<string>",
    "mappings": [
      {
        "source_path": "LOAN_APPLICATION:income",
        "destination_paths": [
          "MONTHLY_INCOME:amount",
          "ANNUAL_INCOME:amount"
        ]
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "rules": [
      {
        "name": "Check Business Name",
        "key": "CHECK_BUSINESS_NAME",
        "execution_order": "before-all",
        "on_success": "PASS",
        "on_fail": "WARN",
        "step_key": "<string>",
        "workflow_id": "work_xxx",
        "workflow_version_id": "workv_xxx",
        "workflow_use_latest": true,
        "workflow_input_default": {
          "business_name": "Example Corp"
        },
        "disabled": false,
        "workflow": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "app": {
            "id": "<string>",
            "name": "<string>",
            "verified": true
          },
          "version": {
            "id": "<string>",
            "app_id": "<string>",
            "workflow_id": "<string>",
            "description": "<string>",
            "version": 123,
            "rollback_version": 123,
            "notes": "<string>",
            "created_by": {
              "id": "<string>",
              "name": "<string>"
            },
            "created_at": "2023-12-25",
            "key": "<string>",
            "input": {},
            "input_default": {},
            "input_options": {
              "display": {
                "field": "inline",
                "container": "grid",
                "hidden": true
              }
            },
            "steps": [
              {
                "type": "note",
                "key": "<string>",
                "conditional": "<string>",
                "loop": "<string>",
                "throw_on_error": true,
                "input_connected": true,
                "destinations": [
                  "<string>"
                ],
                "position": [
                  123
                ],
                "size": [
                  101
                ],
                "auto": {
                  "provider": "<string>",
                  "model": "<string>",
                  "temperature": 1
                },
                "note": "<string>"
              }
            ]
          },
          "tags": [
            {
              "id": "<string>",
              "name": "<string>",
              "color": "<string>",
              "app_id": "<string>",
              "created_at": "2023-12-25",
              "updated_at": "2023-12-25"
            }
          ],
          "tests_stats": {
            "total_count": 123,
            "running_count": 123,
            "cancelled_count": 123,
            "passing_count": 123,
            "failing_count": 123,
            "expectations_failing_count": 123,
            "expectations_passing_count": 123
          },
          "template_id": "<string>",
          "runs_count": 0,
          "enabled": true,
          "deleted": false,
          "created_at": "2023-12-25",
          "updated_at": "2023-12-25",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "input_options": {
            "display": {
              "field": "inline",
              "container": "grid",
              "hidden": true
            }
          },
          "steps": [
            {
              "type": "note",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "throw_on_error": true,
              "input_connected": true,
              "destinations": [
                "<string>"
              ],
              "position": [
                123
              ],
              "size": [
                101
              ],
              "auto": {
                "provider": "<string>",
                "model": "<string>",
                "temperature": 1
              },
              "note": "<string>"
            }
          ]
        },
        "workflow_version": {
          "id": "<string>",
          "app_id": "<string>",
          "workflow_id": "<string>",
          "description": "<string>",
          "version": 123,
          "rollback_version": 123,
          "notes": "<string>",
          "created_by": {
            "id": "<string>",
            "name": "<string>"
          },
          "created_at": "2023-12-25",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "input_options": {
            "display": {
              "field": "inline",
              "container": "grid",
              "hidden": true
            }
          },
          "steps": [
            {
              "type": "note",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "throw_on_error": true,
              "input_connected": true,
              "destinations": [
                "<string>"
              ],
              "position": [
                123
              ],
              "size": [
                101
              ],
              "auto": {
                "provider": "<string>",
                "model": "<string>",
                "temperature": 1
              },
              "note": "<string>"
            }
          ]
        }
      }
    ]
  },
  "entity": {
    "id": "<string>",
    "entity_id": "<string>",
    "status": "SYNCED",
    "type": "ENCOMPASS",
    "trigger_id": "<string>",
    "record_id": "<string>",
    "data": {},
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  }
}

API Reference

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Update a Record

Path Parameters

Query Parameters

Body

Response