Skip to main content

Update a Flow

PUT 

/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.

Body

required
    data object
    description string

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

    enabled boolean
    name string

    The name of a flow/template.

    id uuid

    A unique identifier for a resource.

    slug string

    A unique slug identifier for a flow/template.

    type string

    Represents the type of object being returned.

Responses

Schema
    data object
    id uuid

    A unique identifier for a resource.

    type string

    A unique identifier for a flow/template.

    name string

    The name of a flow/template.

    slug string

    A unique identifier of a flow/template.

    description string

    A short description for a flow/template.

    enabled boolean
    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:

    PropertyDescription
    currentAlways the current page
    firstAlways the first page
    lastnull if there is only one page.
    prevnull if you are on the first page.
    nextnull if there is only one page.
    self string
    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
    id uuid

    A unique identifier for a resource.

    type string

    Represents the type of object being returned.

    meta object
    owner string

    Possible values: [store, organization]

    The resource owner, either organization or store.

    timestamps object
    created_at string

    The date and time a resource is created.

    updated_at string

    The date and time a resource is updated.

Loading...