DOdotfile
Client portal

Share client portal link

Changed on

Generate an authenticated link to access a client portal for a business contact.

The returned access_mode tells whether the business contact enters the portal directly (standard) or verifies their email address first (secured).

See also

Learn more about Cases

post/v1/cases/{id}/share-client-portal-link

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

Path parameters

idstring uuid required

Id of the case

Request body

client_portal_idstring uuid required
business_contact_idstring uuid

The business contact needs to exists in the case.

If the individual is not yet business contact, it will be updated to be marked as such.

If not specified, the case must have a business contact already and it will be used.

Response

ℹ️ Click to see full payload

case_idstring uuid required
client_portal_idstring uuid required
linkstring url required

URL to the client portal authenticated for the business contact.

Do not tamper with the link: send it to the business contact as is.

expires_atstring date-time required

Follows the share link validity published on the client portal. With access_mode standard, the link can be reopened until this date. With secured, the business contact verifies their email address each time and this date does not apply while the portal stays secured.
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

access_mode'standard' | 'secured' required

Access mode published on the client portal when the link was issued. With standard, the link opens the portal directly. With secured, the business contact receives a one-time login link by email before entering the portal. Links issued before the portal supported access modes are always standard.

Changes