Multipass API

Create and persist a new flow definition

Validates and creates a new Multipass flow definition with the specified flow ID. The flow definition must be valid JSON containing the flow configuration.

post/v1/multipass/flows/{flowId}

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/multipass/flows/{flowId}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

flowIdstring required

Unique identifier for the Multipass flow

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

flowIdstring required
startOperatorIdstring required
inputDataKeystring required
inputDataKeyOrDefaultstring

Response

Flow definition created successfully

operationstring required
statusstring required
flowIdstring required

Changes

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