Skip to main content

GuidedSellingFlowVersion

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

One immutable version of a flow's content. Select content to read what it holds; listings stay light when it is left out.

type GuidedSellingFlowVersion {
  id: ID!
  flowId: ID!
  version: Int!
  status: GuidedSellingFlowVersionStatus!
  createdAt: DateTime!
  publishedAt: DateTime
  createdBy: Int
  warmStatus: GuidedSellingWarmStatus
  warmError: String
  warmedAt: DateTime
  content: GuidedSellingFlowVersionContent!
}

Fields​

GuidedSellingFlowVersion.id ● ID! non-null scalar​

Unique identifier of the version (UUID v7).

GuidedSellingFlowVersion.flowId ● ID! non-null scalar​

The flow this version belongs to.

GuidedSellingFlowVersion.version ● Int! non-null scalar​

Sequential number of the version within its flow, starting at 1.

GuidedSellingFlowVersion.status ● GuidedSellingFlowVersionStatus! non-null enum​

Where the version is in its life: draft, published or archived.

GuidedSellingFlowVersion.createdAt ● DateTime! non-null scalar​

Moment the version was created.

GuidedSellingFlowVersion.publishedAt ● DateTime scalar​

Moment the version went live. Null for a draft.

GuidedSellingFlowVersion.createdBy ● Int scalar​

Unique identifier of the user who created this version. Null when it was created with an API key.

GuidedSellingFlowVersion.warmStatus ● GuidedSellingWarmStatus enum​

How preparing the first screens went after the last publish (or after a runtime change). Null when it never ran. RUNNING; DONE: no branch failed; PARTIAL: some failed; FAILED: all failed, and customers will get the error in warmError too.

GuidedSellingFlowVersion.warmError ● String scalar​

The model vendor's first complaint while preparing, in its own words, e.g. "LLM_AUTH_FAILED: The model vendor refused the guide's key: invalid x-api-key" or "LLM_MODEL_NOT_FOUND: ...".

GuidedSellingFlowVersion.warmedAt ● DateTime scalar​

Moment preparing finished.

GuidedSellingFlowVersion.content ● GuidedSellingFlowVersionContent! non-null object​

What the version holds: the instruction, the catalogue and the settings, as they were supplied. Send it back, changed, to guidedSellingFlowVersionCreate to make the next version.

Returned By​

guidedSellingFlowVersionCreate mutation ● guidedSellingFlowVersionPublish mutation

Member Of​

GuidedSellingFlowVersionResponse object