Configure the form entry assignees API in FireForm

On this page:


Overview

You can change who is assigned to review a FireForm form entry with the Form Entry Assignee (Put) API. The API will overwrite any existing assignees.

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/assignees 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

Assignees

List of network IDs for intended assignees

Alphanumeric; list of network IDs separated by commas (2,000 characters max)

N

Groups

List of ACM groups for intended assignees

Alphanumeric; list of ACM group names separated by commas (2,000 characters max)

N

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": "mtexempt",
 "EntryShortId": 375831,
 "Assignees": [
  "ashbush",
  "schulzs"
 ],
 "Groups": [
  "Goal Diggers PO",
  "Product Pushers PO"
 ]
}

Example return

No content is returned if successful.

Get help

If you have additional questions, need to report a bug, or would like to make enhancement requests for the FireForm system, submit a FireForm Support Request.

Related documents

This is document bgcd in the Knowledge Base.
Last modified on 2023-07-18 11:43:21.