Embedded APIResourcesRecipes

Start recipe in a customer workspace

Starts a recipe in a customer workspace specified by recipe ID.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

recipe_idstringRequired
The ID of the recipe you plan to start.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Success reply. If the recipe can't be started due to errors, the API responds with `success: false` and includes details in the `code_errors` or `config_errors` arrays: - `code_errors`: Issues found in the recipe logic, such as missing required fields or invalid attribute values. - `config_errors`: Issues in the recipe setup, such as missing or deleted connections.
successboolean

Errors