Create an invite code for a site's agent

Embed

<a href="https://seolyticize.com/docs/ref-create-invite-code"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/48aea1e4-8f82-4067-a7e5-76c8d072572e/social-card.svg?v=3e7ae33eec8b" alt="Create an invite code for a site's agent" width="600" height="315"></a>

POSThttps://seolyticize.com/api/v1/tools/create_invite_code

Answers 'let an agent connect its own site without our admin key'. Makes a code to hand to the agent that runs one site. The agent sends it, with its domain, to POST /api/v1/claim (no key needed) and gets back a key pinned to the one new client for that site, with the site_admin role: full control of that client, nothing else in the agency. The code is in this response once. maxUses (default 1) is how many sites it can claim; expiresInDays ends the code, keyExpiresInDays the keys it makes. Free.

Request body application/json

labelstringrequired

maxUsesinteger

= 1

expiresInDaysinteger

keyExpiresInDaysinteger

{
  "label": "string",
  "maxUses": 1,
  "expiresInDays": 0,
  "keyExpiresInDays": 0
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/create_invite_code" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","maxUses":1,"expiresInDays":0,"keyExpiresInDays":0}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/create_invite_code', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"label":"string","maxUses":1,"expiresInDays":0,"keyExpiresInDays":0}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/create_invite_code",
    headers={
    "Content-Type": "application/json",
    },
    json={"label": "string", "maxUses": 1, "expiresInDays": 0, "keyExpiresInDays": 0},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/create_invite_code", strings.NewReader(`{"label":"string","maxUses":1,"expiresInDays":0,"keyExpiresInDays":0}`))
	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_invite_code');
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, '{"label":"string","maxUses":1,"expiresInDays":0,"keyExpiresInDays":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/create_invite_code')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"label":"string","maxUses":1,"expiresInDays":0,"keyExpiresInDays":0}'
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_invite_code"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"label\":\"string\",\"maxUses\":1,\"expiresInDays\":0,\"keyExpiresInDays\":0}"))
    .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