FLfloweq
Records

Run a FlowEQ Step in Workboard

Run a specific FlowEQ step against a specific Workboard Record

put/records/{record_id}/steps

Request

  • Base URL
    https://api.floweq.com/v1
  • Auth
    HTTP bearer

Path parameters

record_idstring required

Request body

object required

Create a temporary access token that may be used to update a single record

Example request

{
  "type": "pdf_create",
  "inputs": {
    "pdf_filename": "pdf_filename",
    "pdf_title": "PDF Title",
    "template_id": "template_id"
  }
}

Response

Step Run Success

unknown required

Example response

{
  "details": {
    "status": "success",
    "submission": {
      "id": "submission_id",
      "template_id": "template_id",
      "batch_id": null,
      "state": "pending",
      "test": true,
      "editable": null,
      "expired": false,
      "expires_at": null,
      "password": null,
      "json_schema_errors": [],
      "truncated_text": {},
      "metadata": {
        "company_id": "company_id",
        "pdf_filename": "pdf_filename",
        "record_id": "record_id"
      },
      "processed_at": null,
      "data_requests": [],
      "pdf_hash": null,
      "download_url": null,
      "permanent_download_url": null,
      "actions": []
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.