Actions122
- Availability Actions
- Branch Actions
- Call Log Actions
- Client Portal Actions
- Completion Actions
- Contact Actions
- Contact Note Actions
- Contact Order Actions
- Contact Referral Actions
- Document Actions
- Global Search Actions
- Lead Actions
- Listing Actions
- Listing Inspection Actions
- Listing Issue Actions
- Listing Key Actions
- Listing Link Actions
- Listing Media Actions
- Listing Note Actions
- Listing Offer Actions
- Listing Onboarding Check Actions
- Listing Room Actions
- Listing Search Actions
- Listing Valuation Actions
- Listing Viewing Actions
- Notification Actions
- Search Region Actions
- Task Actions
- Tenancy Actions
- User Actions
- Webhook Actions
Client Portal → Get Sign-In URL
AI-generatedSummary
Generate a sign-in URL for a client portal user based on their email address, optionally sending an invitation if the user is not found.
Inputs
- Email (required) — The email address of the client portal user for whom to generate the sign-in URL.
- Send Invite If Not Found — Specifies whether to send an invitation to the email if no existing user is found (Yes or No). Defaults to No.
- Custom Headers — Additional HTTP headers to include with the request, provided as name-value pairs.
Output shape
a single JSON object containing the sign-in URL or relevant invitation status information
The operation returns a single object with the sign-in URL tied to the given email. If 'Send Invite If Not Found' is enabled and the user does not exist, an invitation may be sent, and the output will reflect that action's result.
Examples
Example 1: Generate sign-in link for existing portal user
Provide user's email; set 'Send Invite If Not Found' to No; optionally add any custom headers needed by the API.
Example 2: Generate sign-in link and invite if user absent
Provide email; set 'Send Invite If Not Found' to Yes; include any custom headers for authentication.