Shortcuts

Update Shortcut

Changes a shortcut you created. Send only the fields you want to change.

  • name, description, icon_emoji — metadata, applied immediately.
  • visibility — org lets everyone in your organization use the shortcut; private limits it to you and the people it is shared with (Share Shortcut). Applied immediately, with no new version.
  • outputs — the full list of fields a run returns, in the same shape Create Shortcut takes. It replaces the previous outputs, is written onto the workflow's output_shortcut action, and publishes a new version of the shortcut. The version is re-derived from the workflow, so input columns added since the last publish are picked up at the same time; every existing input keeps its type, required flag and default. An output whose name is unchanged keeps its identity.

A shortcut is frozen at publish: editing the workflow on its own (Configure Action, Add Inputs) never changes what the shortcut takes or returns. This is the call that does.

For a shortcut shared globally by Floqer, this changes the source version used by new global runs. It requires verified Floqer publishing authority; accepted runs retain their original version.

Making a shortcut private while another workflow's Call Shortcut cell still calls it is refused with 409 SHORTCUT_HAS_CALLERS, naming the callers; send force: true to make it private anyway and break those calls.

Removing an output that another workflow's Call Shortcut cell reads is refused with 409 SHORTCUT_CONTRACT_BREAK, naming the outputs and the callers; send force: true to publish anyway and mark those call sites broken. A refused call changes nothing — not the workflow, not the shortcut.

Runs already in flight finish on the version they started on.

patch/api/v1/shortcuts/{id}

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

idstring required

App ID

Request body

namestring

New display name.

descriptionstring

New description.

icon_emojistring

New icon emoji.

visibility'org' | 'private'

Who can use the shortcut. org: everyone in your organization. private: you and the people it is shared with (Share Shortcut).

forceboolean

Proceed even when the change breaks another workflow's Call Shortcut cell: new outputs that remove a field it reads (409 SHORTCUT_CONTRACT_BREAK otherwise), or visibility: "private" while it still calls the shortcut (409 SHORTCUT_HAS_CALLERS otherwise). Those call sites break. Defaults to false.

Example request

{
  "name": "Company Enrichment v2",
  "icon_emoji": "🏢",
  "outputs": [
    {
      "name": "Company Website",
      "value": "{{enrich_company_linkedin_profile_1.company_website}}"
    },
    {
      "name": "Employee Count",
      "value": "{{enrich_company_linkedin_profile_1.employee_count}}"
    }
  ],
  "extensions": {
    "sales_navigator": null
  }
}

Response

Default Response

statusinteger
messagestring

Example response

{
  "data": {
    "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
    "workflow_id": "531952c2-3d07-4be2-8c4b-733acba3187b",
    "name": "Company Enrichment",
    "description": "Enriches company data from a LinkedIn URL",
    "creator_email": "user@company.com",
    "input_schema": [
      {
        "reference": "linkedin_url",
        "name": "LinkedIn URL",
        "description": "Full LinkedIn company profile URL",
        "type": "text",
        "required": true
      }
    ],
    "output_schema": [
      {
        "name": "Company Website",
        "description": "Main website URL of the company",
        "display_column": "Company Website"
      }
    ],
    "is_master": true,
    "is_published": true,
    "callable": true,
    "extensions": {
      "linkedin": "linkedin_url"
    },
    "icon_emoji": "🏢"
  }
}

Changes

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