API documentation

PUT /key_press_flow_groups/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/key_press_flow_groups/:id

Update Key Press Flow Group by id.

Updates a Key Press Flow Groups name or description by id. The individual key press flows inside the group are not changed by this call.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
redirect_no_key_press Optional Blank value allowed	If the caller doesn’t press a key, use the flow configured for no key press instead. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Param name

Description

name
Optional Blank value allowed

Name

Must be a String

description
Optional Blank value allowed

Description

Must be a String

redirect_no_key_press
Optional Blank value allowed

If the caller doesn’t press a key, use the flow configured for no key press instead.

Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/key_press_flow_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Key Press Flow Group (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "key_press_flow_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "KeyPressFlowGroup",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/key_press_flow_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/key_press_flow_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Example Key Press Flow Group (renamed)",
    "redirect_no_key_press": null,
    "sortable_order": -7,
    "description": "Key press flow group created for API documentation examples"
  },
  "metadata": {
    "root": "key_press_flow_group"
  }
}