Update a Collection

PATCH

apps

{app_id}

collections

{collection_id}

curl --request PATCH \
  --url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Updated Collection Name",
  "description": "Updated collection description",
  "tags_ids": [
    "tag_xxx",
    "tag_yyy"
  ]
}'

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "app": {
    "id": "<string>",
    "name": "<string>",
    "verified": true
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "records_count": 123,
  "deleted": true,
  "triggers": [
    {
      "id": "<string>",
      "type": "ENCOMPASS",
      "name": "My Encompass Trigger",
      "config": {
        "type": "ENCOMPASS",
        "mappings": [
          {
            "type": "document",
            "name": "<string>",
            "entity_path": "<string>",
            "input_path": [
              "<string>"
            ]
          }
        ],
        "pull_on_millestones": [
          "Application Received",
          "Underwriting Complete",
          "Clear to Close"
        ],
        "pull_on_folders": [
          "Loan Folder",
          "Document Folder",
          "Underwriting Folder"
        ]
      },
      "enabled": true,
      "connection_id": "con_xxx",
      "collection_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>"
            }
          ]
        }
      }
    ]
  }
}

Path Parameters

app_id

string

required

The ID of the app

collection_id

string

required

The ID of the collection

Body

Specify the changes you want to make to the collection.

How you want to change your collection

name

string

What you want to call your new collection (keep it under 64 characters)

Required string length: 1 - 64

Example:

"My New Collection"

description

string | null

A short blurb about your collection (up to 1024 characters)

Maximum length: 1024

Example:

"This is a description of my new collection"

tags_ids

string[]

Tags you want to add to your collection (up to 20)

Example:

["tag_xxx", "tag_yyy"]

Response

200 - application/json

You'll receive the updated collection details.

Detailed information about a collection including its config (rules, triggers, etc.)

string

required

Unique identifier for the collection

name

string

required

Name of the collection

description

string | null

required

Description of the collection

app

object

required

Public information about an app (organization)

tags

object[]

required

Tags attached to this collection

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

records_count

number

required

How many records are in the collection

deleted

boolean

required

Has the collection been deleted

triggers

object[]

required

Triggers associated with the collection

Detailed information about a trigger

triggers.id

string

required

Unique identifier for the trigger

triggers.type

enum<string>

required

Service that the trigger is connected to

Available options:

ENCOMPASS,

PERSONA

Example:

"ENCOMPASS"

triggers.name

string | null

required

Name of the trigger

Example:

"My Encompass Trigger"

triggers.config

object

required

Configuration of the trigger

triggers.config.type

enum<string>

required

Type of the trigger connection

Available options:

ENCOMPASS

triggers.config.mappings

object[]

Mappings of the trigger

Detailed information about a trigger mapping

triggers.config.pull_on_millestones

string[]

Milestones to pull from Encompass

Example:

[
  "Application Received",
  "Underwriting Complete",
  "Clear to Close"
]

triggers.config.pull_on_folders

string[]

Folders to pull from Encompass

Example:

[
  "Loan Folder",
  "Document Folder",
  "Underwriting Folder"
]

triggers.enabled

boolean

required

Whether the trigger is enabled or not

triggers.connection_id

string | null

required

Unique identifier of the connected service

Example:

"con_xxx"

triggers.collection_id

string

required

Unique identifier of the collection this trigger belongs to

triggers.created_at

string | null

required

Creation date of the trigger

triggers.updated_at

string | null

required

Last update date of the trigger

created_at

string | null

required

Timestamp when the collection was created

updated_at

string | null

required

Timestamp when the collection was last updated

config

object | null

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

Was this page helpful?

Raise issue

Delete a Collection Get Records

curl --request PATCH \
  --url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Updated Collection Name",
  "description": "Updated collection description",
  "tags_ids": [
    "tag_xxx",
    "tag_yyy"
  ]
}'

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "app": {
    "id": "<string>",
    "name": "<string>",
    "verified": true
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "records_count": 123,
  "deleted": true,
  "triggers": [
    {
      "id": "<string>",
      "type": "ENCOMPASS",
      "name": "My Encompass Trigger",
      "config": {
        "type": "ENCOMPASS",
        "mappings": [
          {
            "type": "document",
            "name": "<string>",
            "entity_path": "<string>",
            "input_path": [
              "<string>"
            ]
          }
        ],
        "pull_on_millestones": [
          "Application Received",
          "Underwriting Complete",
          "Clear to Close"
        ],
        "pull_on_folders": [
          "Loan Folder",
          "Document Folder",
          "Underwriting Folder"
        ]
      },
      "enabled": true,
      "connection_id": "con_xxx",
      "collection_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>"
            }
          ]
        }
      }
    ]
  }
}

API Reference

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Update a Collection

Path Parameters

Body

Response