Skip to main content

guidedSellingFlowUpdate

BETA: guided selling can still change in ways that break existing integrations. Backwards compatibility is not guaranteed while it is in beta.

Update the name, the active flag, or replace the model key. Content is versioned: use guidedSellingFlowVersionCreate for that. Switching the flow on or off and replacing its key change what live customers get, so like publishing they need configuration.OWNER; configuration.EDITOR may rename. A new key is first checked with the model of the published version, or of the newest version while none is published. When the published version's warm-up failed, it runs again with the new key. A flow that is switched off serves no storefront and is not warmed, but configuration roles can still test its versions; switching it on warms its published version when that never happened.

Possible errors:

  • GUIDED_SELLING_FLOW_NOT_FOUND_ERROR: no flow with this id in the calling tenant
  • BAD_REQUEST: a field breaks its rule; extensions.originalError.message names each
  • FORBIDDEN: active or modelApiKey changed without configuration.OWNER
  • GUIDED_SELLING_MODEL_UNAVAILABLE_ERROR: the vendor refused the new key; the message gives its reason, extensions.reason the code. Nothing was changed

AUTH: Role=[configuration.OWNER,configuration.EDITOR]; active and modelApiKey need Role=[configuration.OWNER]

guidedSellingFlowUpdate(
  id: ID!
  input: GuidedSellingFlowUpdateInput!
): GuidedSellingFlow!

Arguments​

guidedSellingFlowUpdate.id ● ID! non-null scalar​

Unique identifier of the guided selling flow (UUID v7).

guidedSellingFlowUpdate.input ● GuidedSellingFlowUpdateInput! non-null input​

Type​

GuidedSellingFlow object​

BETA: guided selling can still change in ways that break existing integrations. Backwards compatibility is not guaranteed while it is in beta.

A guided selling flow, for management. Content lives in versions; the storefront needs only guidedSellingStep and the flow's id.