Authentication

Email a client a sign-in link

Changed on

Root and administrators. Emails one client of the caller's account a single-use sign-in link inside a published email template, so a flow can send a branded email the client opens in one click. The template must carry the {sign_in_url} tag. The link is a credential: it is never returned and never logged. 4xx when the client or template is missing or the template has unresolved tags.

post/accounts/send-client-sign-in

Request

Request body

emailstring email required

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

template_keystring required

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

dataobject

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

redirect_pathstring

Path in the app the client lands on after signing in

contact_folderstring

Folder the mail belongs to, echoed in delivery events

task_idstring

Task the mail belongs to, echoed in delivery events

Response

Success

messagestring

Changes