CustomerLoginRequests
POST customer_login_request
Generate and send a login request for a Customer with the given email address for accessing the customer portal
post/v3/customer_login_requests
Request
- Base URLhttps://api.bookingexperts.com
- Auth
- API key in header X-API-KEY
- or OAuth 2Authorization code/oauth/authorizeToken URL/oauth/token
- TypeScripthttps://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/docs/v3/customer_login_requests/post.tsA function with typed inputs. Its response is checked against the schema.
Query parameters
emailstring
Email address to send the customer login request to. Required if no reservation_id is specified. If a reservation is specified, the contact of the reservation will be used.
reservation_idstring
Specifies a reservation for which a customer link should be generated. Required when a redirect_page has been specified.
redirect_pagestring
Page to redirect the customer to. Possible values: guest_list, license_plates, review_form
send_login_urlboolean
Send the generated request to the contact if an email address is present. Defaults to true. Set to false to yield the customer portal login URL in the Location header.
Response
No Content
Changes
No recorded changes to this operation across all 2 revisions of this API.