Customize the Look and Feel of Flow Interviews with the REST API (Pilot)

We’re continuing to pilot REST API resources that give you full access to flows and their interviews. Use the REST API to build your own flow runtime experience.
Note

Note

We provide Flow Runtime REST API to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. Flow Runtime REST API isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for Flow Runtime REST API in the IdeaExchange.

If you’re an existing pilot customer, nothing has changed since the last release.

Here are some of the things that you can do with this API.
  • Apply your company’s branding

  • Create two-column layouts

  • Create choice buttons, instead of requiring users to select a choice and click Next

  • Update screens dynamically based on the user’s response

Example

In this screen, the text box changes based on the answer in the first field. If you select Yes, by email, the text box prompts you for your email address. If you select Yes, by text, the text box prompts you for your phone number instead.

Dynamic screen when the user selects "Yes, by email"Dynamic screen when the user selects "Yes, by text"

Changes Since Winter ’17

The availableActions[] subtype returns a list of key-value pairs. Previously, it returned a list of values.
"availableActions": [
    {
      "id": "FINISH",
      "label": "Finish"
    },
    {
      "id": "PAUSE",
      "label": "Pause"
    }
  ]