Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Client portal

Share client portal link

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

See also

Learn more about Cases

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

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

expires_atstring date-time required

Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)