Configure the form entry routing step API in FireForm

On this page:

Overview
Configuration
Expected input parameters
Return values
Example
Get help

Overview

You can update the routing step of a FireForm form entry with the Form Entry Step (Put) API.

Note:

To request API access for your FireForm tenant, submit a FireForm API Access Request.

Configuration

To configure this API, see /api/v1/forms/entry/step on the FireForm API page.

Expected input parameters

Parameter	Description	Format	Required (Y/N)
FormCode	The form's unique identifier	Alphanumeric (15 characters max)	Y
EntryshortId	The form entry's unique identification number	Integer	Y
Level	Desired routing queue level (or "step")	Integer	Y
State	Desired routing queue state name	Alphanumeric (200 characters max)	Y

Return values

Expected return data

No content is returned if successful.

Other return values

Code	Description
400	Item is null or values are invalid
404	Item not found

Example

Example input

{
 "FormCode": "pubreq",
 "EntryShortId": 1609,
 "Level": 1,
 "State": "New"
}

Example return