Skip to main content
POST
Email a client a sign-in link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string<email>
required

The client. The mail goes to the address on file for that client, never to an address in the body.

template_key
string
required

Key of a published email template that carries the {sign_in_url} tag

data
object

Values for the template's tags. sign_in_url is always the minted link.

redirect_path
string

Path in the app the client lands on after signing in

contact_folder
string

Folder the mail belongs to, echoed in delivery events

task_id
string

Task the mail belongs to, echoed in delivery events

Response

Success

message
string