Sign in
Customer Flow

Update a flow's happy path

Updates the happy path's title, persona, environment, brief or expectations. Omitted fields are left alone; additionalExpectations replaces the set wholesale rather than appending.

Its persona and environment are what the edge cases inherit, so changing them here changes every edge case that does not name its own.

put/v1/customer-flow/{flowId}/happy-path

Path parameters

flowIdstring uuid required

Request body

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

The persona this runs as. Null on an edge case inherits the happy path's.

Example request

{
  "additionalExpectations": [
    {
      "prompt": "The agent confirmed the new appointment time back to the customer"
    }
  ]
}

Response

The updated happy path

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

  • b4a59c7057ca3See the full diff
    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

  • 887b091b3d811See the full diff
    • ○

      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