Send Login Link

Send a magic login link to a Velt workspace owner’s email address using the v2 REST API to authenticate access to the Velt console without a password.

POST /v2/workspace/email/send-login-link

Send Login Link

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workspace/email/send-login-link \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "email": "<string>",
    "continueUrl": "<string>"
  }
}
'

import requests

url = "https://api.velt.dev/v2/workspace/email/send-login-link"

payload = { "data": {
        "email": "<string>",
        "continueUrl": "<string>"
    } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({data: {email: '<string>', continueUrl: '<string>'}})
};

fetch('https://api.velt.dev/v2/workspace/email/send-login-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.velt.dev/v2/workspace/email/send-login-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'email' => '<string>',
        'continueUrl' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.velt.dev/v2/workspace/email/send-login-link"

	payload := strings.NewReader("{\n  \"data\": {\n    \"email\": \"<string>\",\n    \"continueUrl\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/workspace/email/send-login-link")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"email\": \"<string>\",\n    \"continueUrl\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/email/send-login-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"email\": \"<string>\",\n    \"continueUrl\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "result": {
    "status": "success",
    "message": "Login link sent successfully",
    "data": null
  }
}

Use this API to send a login link to a workspace owner’s email address.

This is a public endpoint — no authentication headers are required.

Endpoint

POST https://api.velt.dev/v2/workspace/email/send-login-link

Body

Params

data · object · required

Show properties

email · string · required

Email address to send the login link to.

continueUrl · string · required

Valid URL to redirect the user to after login. The URL’s domain must be an allowed Velt domain (console.velt.dev or localhost); other domains are rejected.

Example Request

{
  "data": {
    "email": "[e-mail]",
    "continueUrl": "https://console.velt.dev/"
  }
}

Example Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Login link sent successfully",
    "data": null
  }
}

Failure Response

If continueUrl is not a valid URL

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "Invalid url for continueUrl"
  }
}

If the continueUrl domain is not allowed

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "The continueUrl domain is not allowed."
  }
}

If email domain is disposable

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "This email domain is not supported."
  }
}

If rate limit exceeded

{
  "error": {
    "status": "RESOURCE_EXHAUSTED",
    "message": "Rate limit exceeded for this endpoint. Try again later."
  }
}

{
  "result": {
    "status": "success",
    "message": "Login link sent successfully",
    "data": null
  }
}