Chilkat Online Tools

phpExt / Salesforce Platform APIs / Launch Flow

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "inputs": [
//     {}
//   ]
// }

$json = new CkJsonObject();

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/services/data/v{{version}}/actions/custom/flow/:flowApiName','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "inputs": [
        {}
    ]
}'
https://domain.com/services/data/v{{version}}/actions/custom/flow/:flowApiName

Postman Collection Item JSON

{
  "name": "Launch Flow",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"inputs\": [\n        {}\n    ]\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/actions/custom/flow/:flowApiName",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "actions",
        "custom",
        "flow",
        ":flowApiName"
      ],
      "variable": [
        {
          "key": "flowApiName",
          "value": "",
          "description": "Flow API Name"
        }
      ]
    },
    "description": "Launches an Autolaunched Flow with the supplied input parameters."
  },
  "response": [
  ]
}