Quick actions

A quick action is an entry on the sparkle menu of a record. The product ships a fixed set, such as Search for News and Company Summary. Those stay in the product. This API lists them and can turn one off. A firm action sits beside them.

Method	Path	What it does
GET	/api/v1/x/quick-actions	Built-ins, then this firm’s actions. Optional entityType
POST	/api/v1/x/quick-actions	Add a firm action
GET	/api/v1/x/quick-actions/{id}	One firm action. The id is a guid
PUT	/api/v1/x/quick-actions/{id}	Replace a firm action
DELETE	/api/v1/x/quick-actions/{id}	Remove a firm action
PUT	/api/v1/x/quick-actions/builtins	Turn a built-in on or off

Any signed-in user may list and read. Create, update, delete, and the built-in switch need admin.tenant.manage, the same check as Administration, Capsure AI, Quick actions.

A built-in item has readOnly: true and an id such as company:news. It includes label, hint, and enabled. You do not edit its text. To turn Search for News off for companies:

{
  "entityType": "company",
  "id": "news",
  "enabled": false
}

id is the built-in id (news), not company:news.

A firm action needs:

• entityType. The sparkle key: company, person, investor, deal, lead, expert, commitment, entity, filing, policy, vendor, or request. Company is stored as company. LegalEntity is stored as entity. A type with no sparkle is 400 unknown_entity.
• label, required, max 80. This is the menu text.
• instruction, required, max 4,000 characters. What Capsure AI should do with the open record.
• expectedOutput, optional, max 2,000. The shape of the answer.
• enabled, optional, default true. False keeps the action and hides it from the sparkle.

Saving it puts it on that record type’s sparkle for the whole firm when it is enabled. There is no private copy and no share step. The instruction cannot add tools or permissions.

Choosing it opens the sidepane. This API does not run it. A field change the model proposes still waits for a person to confirm.

A create or update returns { result, catalogVersion }. The catalog version does not change because a quick action changed.

{
  "entityType": "company",
  "label": "Score thesis fit",
  "instruction": "Read this company and the thesis fit field. Say whether it matches the fund mandate.",
  "expectedOutput": "A one-sentence verdict, then a short note on the gap."
}