Skip to main content
PATCH
/
apps
/
{app_id}
/
collections
/
{collection_id}
Update a Collection
curl --request PATCH \
  --url https://api.example.com/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",
            "entity_path": "<string>",
            "input_path": [
              "<string>"
            ],
            "name": "<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",
  "link": "<string>",
  "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",
        "on_success": "PASS",
        "on_fail": "WARN",
        "workflow_id": "work_xxx",
        "workflow_version_id": "workv_xxx",
        "workflow_use_latest": true,
        "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,
            "notes": "<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>",
                "note": "<string>",
                "display": "expanded",
                "conditional": "<string>",
                "loop": "<string>",
                "throw_on_error": true,
                "input_connected": true,
                "destinations": [
                  "<string>"
                ],
                "position": [
                  123
                ],
                "size": [
                  101
                ],
                "auto": {
                  "provider": "<string>",
                  "model": "<string>",
                  "temperature": 1
                }
              }
            ],
            "rollback_version": 123,
            "created_by": {
              "id": "<string>",
              "name": "<string>"
            }
          },
          "tags": [
            {
              "id": "<string>",
              "name": "<string>",
              "color": "<string>",
              "app_id": "<string>",
              "created_at": "2023-12-25",
              "updated_at": "2023-12-25"
            }
          ],
          "template_id": "<string>",
          "runs_count": 0,
          "retention": {
            "max_age_in_seconds": 3600,
            "preserve_on_failure": true
          },
          "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>",
              "note": "<string>",
              "display": "expanded",
              "conditional": "<string>",
              "loop": "<string>",
              "throw_on_error": true,
              "input_connected": true,
              "destinations": [
                "<string>"
              ],
              "position": [
                123
              ],
              "size": [
                101
              ],
              "auto": {
                "provider": "<string>",
                "model": "<string>",
                "temperature": 1
              }
            }
          ],
          "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
          }
        },
        "workflow_version": {
          "id": "<string>",
          "app_id": "<string>",
          "workflow_id": "<string>",
          "description": "<string>",
          "version": 123,
          "notes": "<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>",
              "note": "<string>",
              "display": "expanded",
              "conditional": "<string>",
              "loop": "<string>",
              "throw_on_error": true,
              "input_connected": true,
              "destinations": [
                "<string>"
              ],
              "position": [
                123
              ],
              "size": [
                101
              ],
              "auto": {
                "provider": "<string>",
                "model": "<string>",
                "temperature": 1
              }
            }
          ],
          "rollback_version": 123,
          "created_by": {
            "id": "<string>",
            "name": "<string>"
          }
        },
        "execution_order": "before-all",
        "step_key": "<string>",
        "workflow_input_default": {
          "business_name": "Example Corp"
        },
        "disabled": false
      }
    ]
  }
}

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 string 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)

Maximum array length: 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.)

​
id
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

​
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

​
created_at
string<date> | null
required

Timestamp when the collection was created

​
updated_at
string<date> | null
required

Timestamp when the collection was last updated

​
link
string
required

Link to the collection in the UI

​
config
object
required