Adding a Workflow to your Retailer via API

Essential knowledge

Author:

Fluent Commerce

Changed on:

24 Oct 2023

Overview

this page is to show how to add a new to your Retailer via the API Put method.

The user needs `WORKFLOW_CREATE`, and `WORKFLOW_UPDATE` permissions to add a new . These permissions are included in the `ORCHESTRATION_ADMIN` role.

To add a new to your Fluent , send your valid JSON to the following URL via the `PUT` method.

`https://{{accountID}}.{{environment}}.api.fluentretail.com/api/v4.1/workflow`

Warning

Never use the `POST` method, even when creating a for the first time. The `POST`method does not validate the . Instead, use `PUT`.

Note

You will need to provide an Auth header to add the via the API.

Note

If you intend to use a production environment, remove the `{{environment}}` from your URL.

If your request was successful, you should receive the following response:

1{
2    "entityId": "{{retailerID}}-{{workflowName}}::{{workflowVersion}}",
3    "eventStatus": "COMPLETE"
4}