Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPortalModalCloseRequest

Request to close the modal.

The requesting integration must have the PORTAL_MODAL_AUTH_TYPE or ALL_AUTH_TYPE authorization scope.

An example request to close the portal associated with modal-id:

example

{
   type: 'portal:modal:close',
   modalId: 'portal-id'
}

Hierarchy

  • IPortalModalCloseRequest

Index

Properties

Properties

modalId

modalId: string

The id for the modal to be closed.

type

Must be ModalClose.

Generated using TypeDoc