Update a Flow

PUT 
https://euwest.api.elasticpath.com/v2/flows/:flowID

• For Commerce, this endpoint updates a flow.
• For Product Experience Manager, this endpoint updates a template.

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the flow/template is not updated.

Request

Path Parameters

flowID uuidrequired

The unique identifier of the flow/template you want to update.

application/json

Bodyrequired

data object

descriptionstring

A brief description of a flow/template outlining details such as purpose, usage instructions, and so on.

enabledboolean

namestring

The name of a flow/template.

iduuid

A unique identifier for a resource.

Example: 00000000-0000-0000-0000-000000000000

slugstring

A unique slug identifier for a flow/template.

typestring

Represents the type of object being returned.

Responses

200

application/json

Schema

Schema

data object
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
A unique identifier for a flow/template.
Example: flow
namestring
The name of a flow/template.
Example: Products
slugstring
A unique identifier of a flow/template.
Example: products
descriptionstring
A short description for a flow/template.
Example: Extends the default product object
enabledboolean
Example: true
links object
Links allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Listing pages use the following:
Property	Description
current	Always the current page
first	Always the first page
last	null if there is only one page.
prev	null if you are on the first page.
next	null if there is only one page.
selfstring
Example: https://euwest.api.elasticpath.com/v2/flows/d2a9b22a-b4b0-456b-bbc7-d8723aaffa84
relationships object
Relationships are established between different flows/templates entities. For example, a field and an entry are related to a flow as both are attached to it.
fields object
data object
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
Represents the type of object being returned.
Example: brand
meta object
ownerstring
The resource owner, either organization or store.
Possible values: [store, organization]
Example: enum
timestamps object
created_atstring
The date and time a resource is created.
Example: 2023-10-11T13:02:25.293Z
updated_atstring
The date and time a resource is updated.
Example: 2023-10-11T13:02:25.293Z

Example (auto)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "flow",
    "name": "Products",
    "slug": "products",
    "description": "Extends the default product object",
    "enabled": true,
    "links": {
      "self": "https://euwest.api.elasticpath.com/v2/flows/d2a9b22a-b4b0-456b-bbc7-d8723aaffa84"
    },
    "relationships": {
      "fields": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "brand"
        }
      }
    },
    "meta": {
      "owner": "enum",
      "timestamps": {
        "created_at": "2023-10-11T13:02:25.293Z",
        "updated_at": "2023-10-11T13:02:25.293Z"
      }
    }
  }
}

default

{
  "data": {
    "id": "6d320b42-237d-4474-8452-d49f884d4ae1",
    "type": "flow",
    "name": "extraFieldRenamed",
    "slug": "products-1",
    "description": "Extends the default product object",
    "enabled": true,
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1"
    },
    "relationships": {},
    "meta": {
      "owner": "store",
      "timestamps": {
        "created_at": "2018-05-10T18:04:26.623Z",
        "updated_at": "2018-05-10T18:11:47.469Z"
      }
    }
  }
}

404

Bad request. Not Found.

application/json

Schema

Schema

errors Error[]required
Array [
statusintrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Not Found",
      "status": 404
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
statusintrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": 500,
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://euwest.api.elasticpath.com/v2/flows/:flowID");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"description\": \"string\",\n    \"enabled\": true,\n    \"name\": \"string\",\n    \"id\": \"00000000-0000-0000-0000-000000000000\",\n    \"slug\": \"string\",\n    \"type\": \"string\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

flowID — pathrequired

Body required

• Example (from schema)
• default

{
  "data": {
    "description": "string",
    "enabled": true,
    "name": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "slug": "string",
    "type": "string"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!