api-docs-icon

Create Login Link

POST
/ api/ v1/ loginlink

Allows your platform to create an auto-login URL for an account.

This auto-login link can then be used to pop up Express Windows with the account already validated. They can also be used for external application to build links that with automatically log the user in and redirect to the given URL. \
\
The link should be used immediately, as it is only valid for a short period of time. \
\
Passing in a url will prepend that to the link in cases of white labelled accounts. Otherwise, the postalytics.com url will be used

object
api_key
string
required

The API key of the the account to create a login link for

Example:
375EE04C-432E-4d6A-943B-1B97FDD7FED7
domain
string
nullable

If left blank, app.postalytics.com is prepended to the URL parameter. Otherwise the domain provided will be used

Example:
https://www.metacortex.net
id
string
nullable

If the url is ‘campaign-dashboard’, ‘campaign-edit’, or ‘template-edit’, an id is set to retrieve the appropriate campaign or template

Example:
10142067
url
string
nullable

The url subpage of the postalytics site you wish to redirect users to. Sample options are 'dashboard', ‘template-create’, ‘contact-import’, ‘template-list’, ‘campaign-create',etc

Example:
dashboard

Response

application/json
object
CreatedDate
string (date-time)

The date and time when the login link was created.

Example:
https://www.metacortex.net/al.aspx?m=oKRD1iQHmXUEQkxihVS9DTvIRKAPM6ZoqrdY+lgRg1F
LoginLink
string
nullable

The generated login link.

Code Examples

Response