FlxpointAPI Help CenterBeta

Run Workflow Mapping Rule

posthttps://api.flxpoint.com/workflow/mapping-rule/run

Use this when you want to create workflow data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Request

Bodyapplication/json
mappingRuleIdsarray[integer]required
The workflow rule ids to run (will be run in the order passed)
integer
objectsobjectrequired
No properties documented.
valueobject
No properties documented.

Example request

post/workflow/mapping-rule/run
curl -X POST "https://api.flxpoint.com/workflow/mapping-rule/run" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "mappingRuleIds": [
           0
         ],
         "objects": {},
         "value": {}
       }'
Example body · application/json
{
  "mappingRuleIds": [
    0
  ],
  "objects": {},
  "value": {}
}

Responses

200OKapplication/json
mappingRuleIdsarray[integer]required
The workflow rule ids to run (will be run in the order passed)
integer
objectsobjectrequired
No properties documented.
valueobject
No properties documented.
Example response
{
  "mappingRuleIds": [
    0
  ],
  "objects": {},
  "value": {}
}
OpenAPI fragment
{
  "post": {
    "summary": "Run Workflow Mapping Rule",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RunWorkflowRuleRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/RunWorkflowRuleRequest"
            }
          }
        }
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight