Product updates
API Reference

Share client portal link

post
https://api.dotfile.com/v1/cases//share-client-portal-link

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

See also

Learn more about Cases

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Body Params
uuid
required
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.

Responses

400

The request is either malformed or contain invalid parameters.

  • Make sure the identifier specified in the URL is a valid UUID
  • Make sure the body payload matches the expected schema
  • Make sure that the client portal is online
  • If business_contact_id is specified, the individual must belong to the case, be relevant, and have an email address. If not already a business contact, they will be marked as one
  • If business_contact_id is not specified, the case must have a business contact
404

No case, client portal or business contact can be found.

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago