Form Field Values

Batch update form field values

Updates multiple form field values (i.e the values for the form fields present in a workflow run). A value may consist of a simple string, may accept multiple values as an array, or it may accept multiple properties.<br> <br> See the examples for a complete reference on setting form field values.<br> <br> Note: File Upload form fields cannot be updated using this endpoint. Use the upload endpoint instead.

post/workflow-runs/{workflowRunId}/form-fields

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/workflow-runs/{workflowRunId}/form-fields
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

Request body

Response

Example response

{
  "fields": [
    {
      "updatedBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.