API Docs / Schemas / PortalAccessStatusDto

PortalAccessStatusDto

Portal access state for a contact on a client, including what granting access would do.

Properties

Name Type Description
hasPortalAccessboolean

Whether the contact currently has portal access on this client.

Whether the contact currently has portal access on this client.

portalUserPortalUserDto
willSendInvitationEmailboolean

Whether granting portal access would send an invitation email. False when the contact
already uses the portal — they simply see the client on their next visit.

Whether granting portal access would send an invitation email. False when the contact
already uses the portal — they simply see the client on their next visit.

JSON Example

{
  "hasPortalAccess": false,
  "portalUser": {
    "code": "string",
    "contactCode": "string",
    "email": "string",
    "contactFirstName": "string",
    "contactLastName": "string"
  },
  "willSendInvitationEmail": false
}

Used By Operations