Modal, WIP

NOTE

This page is a work in progress. Endpoints below haven't been fully researched.

Get modal, WIP

GET /v1/modal

Submit modal action, WIP

POST /v1/modal/{modalName}

Fetch pop-up logic plan, WIP

Requires Authorization.

Returns an ordered plan of modal steps.

POST /v1/popup-logic

Body:

• supportedStepKeys — array of strings, step keys the caller can render, e.g. "profileCompletion"
• context — object

Response:

• schemaVersion — integer
• planVersion — string, Server plan identifier, e.g. pc-pilot.2026-08-12.1.
• steps — array of objects
  • key — string
  • type — string, "MANDATORY" or "OPTIONAL"
  • params — object with string values; for the profileCompletion step, contentUrl is the URL of the step's web page
  • triggerEvent — string or null

Acknowledge pop-up logic step, WIP

Requires Authorization.

POST /v1/popup-logic/ack

Body:

• stepKey — string
• interaction — string, "RENDERED" (the step was shown), "ACCEPTED", "DISMISSED" (closed by the user) or "CANCELED" (ended without any other outcome)