Retrieve Job Details Magic Link
Resource representing a Magic Link for Job details.
The Magic Link resource generates a link to send a user directly to the job details page in the client portal. This will allow you to link to the job 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.
The job must be submitted to generate the Magic Link.
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.
Determines the visibility of the navigation bar.
Allows you to specify the portal view for the magic link that is going to be generated. See details below.
Allow you to specify details of where to return the user after they have completed actions in the client portal. This affects the portal's back button button as well as the session expired page. See details below.
Portal View
The portal view type.
job_details- The portal view type to generate a Magic Link for the job details page.
When the job is under construction and the given user ID has permission to create jobs, it redirects to the onboarding page and the hide_navbar is ignored.
dashboard- The portal view type to generate a Magic Link for the dashboard page.
The job's ID.
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", "hide_navbar": true, "portal_view": { "type": "job_details", "job_id": "job_id_guid" } }'
Response
The Magic Link's URL.
Sample Response
Copied1{2 "url": "https://domain/__sesssion/{payload}?s={signature}"3}