API documentation

GET /key_press_flow_groups/new

Authorization Required

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

Build Key Press Flow Group with defaults.

Returns a Key Press Flow Group built with default attributes for previewing available fields before creating one. It is not saved.

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 'https://[your-subdomain].trackdrive.com/api/v1/key_press_flow_groups/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "key_press_flow_group": {
    "id": null,
    "type": "KeyPressFlowGroup",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/key_press_flow_groups/new",
    "routes_edit_path": "/key_press_flow_groups/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "redirect_no_key_press": null,
    "sortable_order": null,
    "description": null
  },
  "metadata": {
    "root": "key_press_flow_group"
  }
}