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 → Authenticate
AI-generatedSummary
Authenticate a user against the Apex27 CRM Client Portal by submitting their email and password credentials, optionally including custom HTTP headers.
Inputs
- Email (required) — The user's email address to authenticate with the Client Portal.
- Password (required) — The password associated with the provided email for Client Portal authentication.
- Custom Headers — Additional HTTP headers to include in the authentication request, specified as name-value pairs.
Output shape
A JSON object containing authentication response data from the Client Portal, such as tokens or user session information.
The response structure depends on the API endpoint; no pagination applies. Errors are returned according to the Apex27 CRM API conventions.