CreateWorkflowReq

Request body for creating a workflow. Pick exactly one creation path — supply either blueprintKey + blueprintVersion (instantiate from a stored blueprint) or listingKey + listingVersion (instantiate from a library listing). Combining both shapes returns 400.

  • blueprintKey
    Type: string

    Key of the stored blueprint to instantiate, in the same namespace as this request. Required for the blueprint creation path; mutually exclusive with listingKey. To instantiate a blueprint from a different namespace (either elsewhere in your org or in another org), use listingKey instead — the publisher must have published it as a library listing.

  • blueprintVersion
    Type: string

    Version of the blueprint to instantiate (semver, e.g. 1.2.0). Required when blueprintKey is supplied.

  • data
    Type: object

    Entity payload, keyed by the blueprint's input keys. Each entry is validated against the schema declared on the corresponding blueprint input.

    • propertyName
      Type: object
  • description
    Type: string

    Optional human-readable description of the workflow.

  • listingKey
    Type: string

    Key of the library listing to instantiate. Required for the listing creation path; mutually exclusive with blueprintKey.

  • listingVersion
    Type: string

    Version of the listing to instantiate. Required when listingKey is supplied.

  • name
    Type: string

    Optional human-readable name for the workflow. When omitted, defaults to Instance of Blueprint - <blueprintKey>@<blueprintVersion> for the blueprint creation path, or Instance of Library Listing - <listingKey>@<listingVersion> for the listing creation path. The default is unambiguous (key + version pin the source) but unfriendly — most callers override it with a transaction-specific name like "Offer letter — Alex Rivera".

  • options
    Type: object

    Optional creation-time settings — notification toggles, participant overrides, sender-info overrides, and execution mode.

    • disableParticipantNotifications
      Type: boolean

      Defaults to false — SignStack sends a signing-link email to each participant when their step starts. Set to true to suppress those emails when your application surfaces the signing experience itself, typically when embedding <ss-signing-embed> inside your own product, or when you're notifying participants through your own channel (in-app notification, your own transactional email, etc.) and don't want the SignStack-branded email going out alongside it.

    • mode
      Type: stringenum

      Run (default) starts execution after creation. Review creates the workflow in pending status without auto-executing — useful for previews where the caller wants to inspect or edit the workflow before kicking it off.

      values
      • Run
      • Review
    • senderInfoOverrides
      Type: object

      Override the sender block on this workflow's participant emails. Use for white-labeling: surface a different brand on the email a participant receives without changing your namespace's defaults. When supplied, the full block replaces the namespace-level sender info — supply all four required fields together (the technical senderEmail envelope address is always taken from the namespace and cannot be overridden here).