Create a client portal link

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-create-portal-link"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/b0765f9a-abdf-4e2c-8f9a-26fd9bc351ca/social-card.svg?v=3e7ae33eec8b" alt="Create a client portal link" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/create_portal_link

Makes a white-label link that shows one client their own dashboard under the agency's name, with no sign-in. Answers 'give the client a link to their results'. The full address is in this response once and can never be shown again; send it to the client and keep it out of logs. Anyone holding it can see that client's results until it is revoked.

Request body application/json
clientIdstringrequired
labelstringrequired
Who the link is for, so it can be told apart and revoked later
{
  "clientId": "string",
  "label": "string"
}
Code samples
cURL
curl -X POST "https://seolyticize.com/api/v1/tools/create_portal_link" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","label":"string"}'
TypeScript
const res = await fetch('https://seolyticize.com/api/v1/tools/create_portal_link', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","label":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/create_portal_link",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "label": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/create_portal_link", strings.NewReader(`{"clientId":"string","label":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://seolyticize.com/api/v1/tools/create_portal_link');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clientId":"string","label":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/create_portal_link')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","label":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://seolyticize.com/api/v1/tools/create_portal_link"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"label\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 The tool's result, under data.
Example
{
  "data": {}
}
Schema
datarequired
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
401 No key, or a key that is unknown or revoked.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
403 The key's role does not permit the tool, or the key may not reach the named client.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
404 No tool by that name.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
429 This key has used its window.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
500 The request could not be completed.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
Updated