Create Share Link

POST

api

templates

{templateId}

share-link

Create Share Link

curl --request POST \
  --url https://api.sequenzy.com/api/v1/templates/{templateId}/share-link \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/templates/{templateId}/share-link"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/templates/{templateId}/share-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.sequenzy.com/api/v1/templates/{templateId}/share-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/templates/{templateId}/share-link"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/templates/{templateId}/share-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "shareUrl": "https://sequenzy.com/view/email/8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s",
  "shareToken": "8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s",
  "created": true
}

{
  "error": "Invalid API key"
}

{
  "error": "Template not found"
}

Create a public, shareable “view in browser” link for an individual email - a transactional email, a sequence email, or a standalone template. The hosted page renders an anonymized copy - a sample contact instead of subscriber data, an inert unsubscribe link, and no open or click tracking - so you can forward the URL to anyone. Emails wired to a transactional template render without the unsubscribe footer, matching how they are sent. The call is idempotent: if a link is already active, the same URL is returned with created: false instead of rotating it, so copies you have already shared keep working. Revoke it with Revoke Share Link. The current link is also reported as shareUrl on Get Template (null when none is active). Campaigns have their own campaign-level link that follows the A/B winning variant - use Create Share Link on the campaign instead.

Request

string

required

Email/template ID, or a transactional email’s ID or slug. For a sequence email, use the step’s emailId.

This endpoint does not accept a request body.

curl -X POST "https://api.sequenzy.com/api/v1/templates/order-confirmation/share-link" \
  -H "Authorization: Bearer YOUR_API_KEY"

Responses

{
  "success": true,
  "shareUrl": "https://sequenzy.com/view/email/8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s",
  "shareToken": "8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s",
  "created": true
}

{
  "error": "Invalid API key"
}

{
  "error": "Template not found"
}

Create Share Link

curl --request POST \
  --url https://api.sequenzy.com/api/v1/templates/{templateId}/share-link \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/templates/{templateId}/share-link"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/templates/{templateId}/share-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.sequenzy.com/api/v1/templates/{templateId}/share-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/templates/{templateId}/share-link"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/templates/{templateId}/share-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "shareUrl": "https://sequenzy.com/view/email/8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s",
  "shareToken": "8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s",
  "created": true
}

{
  "error": "Invalid API key"
}

{
  "error": "Template not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Sending Status

Notification Preferences

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

Email Components

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Create Share Link

Request

Responses

​Request

​Responses

Request

Responses