Skip to main content

GuidedSellingFlowCreateInput

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

A new flow: its name, the model key it bills to, and version 1 as a draft.

input GuidedSellingFlowCreateInput {
  name: String!
  active: Boolean = true
  modelApiKey: String!
  content: GuidedSellingFlowVersionContentInput!
}

Fields​

GuidedSellingFlowCreateInput.name ● String! non-null scalar​

Display name of the flow, for management screens, 1 to 255 characters. Customers never see it.

GuidedSellingFlowCreateInput.active ● Boolean scalar​

An inactive flow refuses guidedSellingStep from storefronts (GUIDED_SELLING_FLOW_INACTIVE_ERROR). Users and keys with configuration.EDITOR or OWNER can still run it, to test it.

GuidedSellingFlowCreateInput.modelApiKey ● String! non-null scalar​

The model vendor key this flow bills to, 8 to 512 characters. Write only: stored encrypted, never returned by any query.

GuidedSellingFlowCreateInput.content ● GuidedSellingFlowVersionContentInput! non-null input​

Version 1, created as a draft.

Member Of​

guidedSellingFlowCreate mutation