Retrieve Waitlist Magic Link
Resource representing a Magic Link for Waitlist.
The Magic Link resource generates a link to send a user directly to the waitlist in the client portal. This will allow you to link to the waitlist without requiring the user to login to the client portal.
Magic Links are only valid for 5 minutes and the Magic Link sessions are only valid for 24 hours.
Endpoints
| Method | Url |
|---|---|
POST | /v1.0/magic-link |
Request Parameters
The user ID this magic link is being generated for.
The email this magic link is being generated for. A new email will result in a new member being created.
Only an email or user_id is required, not both.
Allows you to specify the portal view for the magic link that is going to be generated. See details below.
Allows you to specify details about where to return the user to after they have completed actions in the client portal. This affects the portal's back button as well as the session expired page. See details below.
Allows you to specify a list of legend IDs that the user can create jobs from. Omitting this field will result in the user being able to create jobs from all legends that are enabled for job creation.
Portal View
The portal view type.
waitlist- The portal view type to generate a Magic Link for the waitlist page.
Return Options
The URL to return the user to.
The label to display on the back button.
Sample Request
Copied1curl -X POST 'https://api.worklayer.com/v1.0/magic-link' \2-H 'Authorization: Bearer {token}'3-d '{ "user_id": "user_id_guid", "portal_view": { "type": "waitlist" }, "return_options": { "url": "the_url", "action_label": "the_action_label"}, "allowed_legend_ids": ["legend_id"] }'
Response
The Magic Link's URL.
Sample Response
Copied1{2 "url": "https://domain/__session/{payload}?s={signature}"3}