Create - Stytch Docs

// POST /v1/magic_links
const stytch = require('stytch');

const client = new stytch.Client({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  user_id: "${userId}",
};

client.MagicLinks.Create(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

{
  "request_id": "<string>",
  "user_id": "<string>",
  "token": "<string>",
  "status_code": 123
}

POST

magic_links

// POST /v1/magic_links
const stytch = require('stytch');

const client = new stytch.Client({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  user_id: "${userId}",
};

client.MagicLinks.Create(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });

{
  "request_id": "<string>",
  "user_id": "<string>",
  "token": "<string>",
  "status_code": 123
}

Access to this endpoint is restricted. To enable it, please send us a note at support@stytch.com.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request type

user_id

string

required

The unique ID of a specific User. You may use an external_id here if one is set for the user.

expiration_minutes

integer<int32>

Set the expiration for the Magic Link token in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).

attributes

object

Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application.

Show child attributes

Response

Successful response

request_id

string

required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

user_id

string

required

The unique ID of the affected User.

token

string

required

The Magic Link token that you'll include in your contact method of choice, e.g. email or SMS.

status_code

integer<int32>

required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

⌘I