Customer Flow Edge Case

Add an edge case

Adds a variant to an IMPROV flow.

A scripted flow's variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here.

Leave personaOverrideId or environmentId unset to inherit the happy path's.

post/v1/customer-flow/{flowId}/edge-case

Path parameters

flowIdstring uuid required

Request body

titlestring required
environmentIdstring uuid nullable
promptstring nullable
precededByCustomerFlowIdstring uuid nullable
precededByCustomerFlowVariantIdstring uuid nullable
personaOverrideIdstring uuid nullable

The persona this runs as. Omit to inherit the happy path's.

Response

The edge case that was added

Example response

{
  "data": {
    "personaOverride": {
      "backstoryPrompt": "A busy professional calling during lunch break",
      "properties": {
        "age": 35,
        "zipCode": "94105",
        "occupation": "Software Engineer"
      }
    }
  }
}

Changes

Changed in 2 of the 105 revisions of this API.4

    • added the required property data/oneOf[subschema #1: Scripted]/personaOverride/age to the response with the 201 status

      response-required-property-added

    • added the required property data/oneOf[subschema #2: Improv]/personaOverride/age to the response with the 201 status

      response-required-property-added

    • added the required property data/oneOf[subschema #3: Voicemail]/personaOverride/age to the response with the 201 status

      response-required-property-added

    • endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog