ROroarkhq
Customer Flow

Update a flow's happy path

Changed on

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

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/customer-flow/{flowId}/happy-path
  • Auth
    HTTP bearer

Path parameters

flowIdstring uuid required

Request body

titlestring
environmentIdstring uuid nullable
promptstring nullable
precededByCustomerFlowIdstring uuid nullable
precededByCustomerFlowVariantIdstring uuid nullable
includeFlowExpectationsboolean

Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only.

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"
      },
      "phoneNumber": "+19312830919"
    }
  }
}

Changes

  • f747fc3e482cRevision changes
    • info

      added the new optional request property

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • e32b31fc8f98Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status