Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
Individual Workflows

Execute a workflow for the given service profile

Execute a workflow for the given service profile.

post/v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute

Headers

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-Background0 | 1

If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.

X-Frankie-Usernamestring
Example:fred.flintstone@frankieone.com

Username provided by API caller

Request body

Example request

{
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

Execution request completed

requestIdstring

The unique request identifier for the API call made.