Skip to main content

Insurer Greeting

Use the Insurer Greeting modal to welcome users from a specified insurance company and introduce the appointment service.



This screen includes:

#ElementDescription
1Modal titleDisplays the welcome message
2Close actionDismisses the modal
3Insurer logoIdentifies the insurance company
4IntroductionDescribes the appointment service
5Continue buttonCloses the modal and continues

Workflow​

  1. Open the application for the specified insurance company.
  2. Call PUT /api/v3/insurers/{company-id}/greetings.
  3. Display the insurer greeting.
  4. Review the welcome message.
  5. Select Continue to access the application.
  6. Select the close icon to dismiss the modal.

Search Behavior​

  • A brand match returns the brand and its associated insurer.
  • An insurer match returns the insurer and its associated brands.

Validations​

ScenarioApp behaviorSDK output
Company ID is missing or invalidBlock the requesterror = invalid_company_id
Greeting content is availableDisplay the greetingstate = ready
Request failsDisplay an error statestate = error
Session is invalidBlock accessstate = unauthenticated

Actions​

ScenarioApp behaviorSDK output
Greeting request succeedsDisplay the insurer greetingPage object
Continue selectedDismiss the modal and continueNavigation event
Close selectedDismiss the modalNavigation event

Endpoint Resources​

Greetings​

PUT 

v3/insurers/{company-id}/greetings

Returns a greeting popup or page for the specified insurance company.

ParameterLocationTypeRequiredDescription
company-idPathIntegerYesIdentifies the insurance company

Update Greetings​

PATCH 

v3/insurers/{company-id}/greetings

Returns a greeting popup or page for the specified insurance company.