setGuidedFlows

Requires permission settings:tenant:update.

Replaces the organization's whole set of product finders with the list given. Every flow is validated, and every category and brand it names must exist in the organization, before anything is saved, so a refused flow writes nothing. Requires permission to update tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SetGuidedFlows($input: SetGuidedFlowsInput!) {
  setGuidedFlows(input: $input) {
    id
    imageUrl
    label
    surfaces
    openFrom {
      attributeKey
      except
      kind
      mode
      values
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetGuidedFlows($input: SetGuidedFlowsInput!) {\n  setGuidedFlows(input: $input) {\n    id\n    imageUrl\n    label\n    surfaces\n    openFrom {\n      attributeKey\n      except\n      kind\n      mode\n      values\n    }\n  }\n}",
  "variables": {
    "input": {
      "flows": {}
    }
  }
}
EOF

Variables:

{
  "input": {
    "flows": {}
  }
}

Response:

{
  "data": {
    "setGuidedFlows": [
      {
        "id": "id",
        "imageUrl": "string",
        "label": "string",
        "surfaces": [
          "BUYER"
        ],
        "openFrom": [
          {
            "attributeKey": "string",
            "except": [
              "string"
            ],
            "kind": "ATTRIBUTE",
            "mode": "ALL",
            "values": [
              "string"
            ]
          }
        ]
      }
    ]
  }
}

setGuidedFlows(
  input: SetGuidedFlowsInput!
): [GuidedFlow!]!

Arguments

setGuidedFlows.input ● SetGuidedFlowsInput! non-null input

The complete list of guided flows to save.

Type

GuidedFlow object

A guided flow that helps a buyer find the right variant step by step.