GCgc-ai
Contract Intelligence

Update a vault column

Change a column's label, instructions, value type, option list, fill mode, or placement. Send only the fields you want to change; everything you leave out keeps its current value. field_key is not one of them: it is frozen at creation so the values already extracted stay attached.

Changing the value type of an ai column makes the values already extracted for it stale, because they were stored as text read under the old type. GC AI queues a re-scan of the documents that hold one and reports it in auto_rescan. The column is saved whatever auto_rescan says, so treat that field as news about the re-scan and not as an error. When the vault is waiting on a scan review, the re-scan waits for that approval instead of starting now.

Only a custom column accepts changes. A system column (Document Name, Document Status, Document Title) returns 400, and so does a column a connected spreadsheet owns if you try to move it in or out of import.

Requires the editor or owner role in the vault and the organization-level permission to manage vaults.

Requires a user-scoped API key (u:gcai_...). A vault is shared with named people, so an organization-scoped key has no identity to resolve vault access with.

patch/vaults/{id}/columns/{columnId}

Request

Path parameters

idstring uuid required

The vault ID

columnIdstring uuid required

The column ID from GET /vaults/{id}/columns. Built-in columns report id: null and cannot be addressed here.

Request body

labelstring

New column heading. The field_key does not follow a rename, so every value already extracted stays attached.

instructionsstring

New instructions.

field_type'text' | 'date' | 'date_range' | 'enum' | 'multi_enum' | 'boolean' | 'number' | 'currency' | 'percentage' | 'duration' | 'email' | 'url' | 'list' | 'rich_text'

New value shape. Send field_meta in the same request when the new type needs a different option list.

extraction_mode'ai' | 'manual'

New fill mode. A column a spreadsheet owns cannot move in or out of import, and a column a connected source owns cannot move in or out of connector, so those columns reject this field.

sort_orderinteger

New placement weight.

Example request

{
  "field_meta": {
    "options": [
      "Renewal",
      "New business",
      "Amendment"
    ]
  }
}

Response

The updated column

idstring uuid nullable required

Unique column identifier, or null for a built-in column. A built-in column has no row of its own in this vault, so it has no ID and cannot be changed or deleted.

field_keystring required

The stable key extracted values are stored under. It is set once, when the column is created, and never changes, so renaming the column keeps every value already extracted for it.

labelstring required

The column heading shown in the vault table

instructionsstring required

For an ai column, the prompt extraction reads each document with. For a manual, import, or connector column, a note to whoever reads the column.

field_type'text' | 'date' | 'date_range' | 'enum' | 'multi_enum' | 'boolean' | 'number' | 'currency' | 'percentage' | 'duration' | 'email' | 'url' | 'list' | 'rich_text' | 'party_list' | 'related_agreement_list' required

The shape of the values in this column. Built-in columns can report party_list and related_agreement_list, which you cannot set yourself.

extraction_mode'ai' | 'manual' | 'import' | 'connector' required

How the column gets filled. ai: extraction reads it out of each document. manual: a person types it and no scan ever touches it. import: values come from a connected spreadsheet, which owns the column. connector: values come from a connected document source, which owns the column. You can create ai and manual columns. An import column is created by connecting a spreadsheet in the app. A connector column is created when a source such as Ironclad fills it.

kind'built_in' | 'system' | 'custom' required

What this column is. built_in: merged into every vault by GC AI, with no ID and no way to change it. system: owned by this vault but managed by GC AI (Document Name, Document Status, Document Title), so it has an ID but rejects every change and every delete. custom: yours, and the only kind PATCH and DELETE accept.

editableboolean required

True when this column can be changed with PATCH /vaults/{id}/columns/{columnId}. Built-in and system columns report false: GC AI owns their name, type, options, and prompt. One exception, on both surfaces: sort_order is list position rather than identity, so it can be set on any column that has an ID.

sort_ordernumber nullable required

Placement weight for this column, or null for a built-in one. The table orders columns by sort_order first and creation time second.

created_atstring nullable required

ISO 8601 creation timestamp, or null for a built-in column

updated_atstring nullable required

ISO 8601 last-update timestamp, or null for a built-in column

Example response

{
  "field_key": "renewalNotice",
  "label": "Renewal notice"
}

Changes

No recorded changes to this operation across all 1 revision of this API.