Set Portal Access

PUT /tenants/{tenant}/clients/{client}/contacts/{code}/portal-access

Grant or revoke portal access for a contact on a client. When granting access, a PortalUser record is automatically created if one doesn't exist for the contact, and the invitation email is (re)sent unless the contact has already logged in to the portal.

Requires: Update on ClientPortalSettings.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

client* path string
code* path string

Request Body*

{
  "hasPortalAccess": false
}

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
404 Not Found