Create a Welcome Smartlink

post

https://prod1.serveture.com/public-api/create_welcome_smartlink/

Creates or recreates the welcome smartlink for workers, returning a unique smartlink per worker to automatically download the WorkN app and log in.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

user_ids

array of int32s

A list of user IDs for which the requester would like to create the smartlink. If provided, this list will take precedence over both worker IDs (worker_ids) and external employee IDs (ext_emlpoyee_ids).

user_ids

worker_ids

array of int32s

A list of provider IDs for which the requester would like to create the smartlink. If provided, this list will take precedence over the external employee IDs (ext_emlpoyee_ids).

worker_ids

ext_employee_ids

array of strings

A list of external employee IDs that the requester would like to create the welcome smartlink for.

ext_employee_ids

resend_link

boolean

Defaults to false

An indication of whether the smartlink should be recreated if the worker has previously logged in to the app. By default, only workers who have never logged in will qualify to have a smartlink created for them.

Headers

Authorization

string

required

Defaults to Token <place token here>

The authorization token returned from the Log In endpoint.

Responses

200200

2XX2XX