Update the client brief

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-update-client-brief"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/1bb9f1f3-c6e2-4009-b07f-b23333f40282/social-card.svg?v=3e7ae33eec8b" alt="Update the client brief" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/update_client_brief

Changes the client brief that every teammate and agent reads. Answers 'remember this about the client'. Set fields (overview, goal, positioning, audience, voice; null or empty clears one, fields left out are untouched); add entries (kind competitor, key_page, section or research, each with a title and optional body and url); edit entries by id; remove entries by id (unknown ids are ignored). Applied in that order, so removing an old competitor and adding its replacement in one call works. Record a research entry when you finish a piece of work whose conclusions the next one should start from; the 50 newest research notes are kept. Returns the brief as it now stands. Free.

Request body application/json
clientIdstringrequired
overviewstring
goalstring
positioningstring
audiencestring
voicestring
addobject[]
Show child parameters
kindstringrequired
competitor | key_page | section | research
titlestringrequired
bodystring
urlstring
updateobject[]
Show child parameters
idstringrequired
titlestring
bodystring
urlstring
removestring[]
{
  "clientId": "string",
  "overview": "string",
  "goal": "string",
  "positioning": "string",
  "audience": "string",
  "voice": "string",
  "add": [
    {
      "kind": "competitor",
      "title": "string",
      "body": "string",
      "url": "string"
    }
  ],
  "update": [
    {
      "id": "string",
      "title": "string",
      "body": "string",
      "url": "string"
    }
  ],
  "remove": [
    "string"
  ]
}
Code samples
cURL
curl -X POST "https://seolyticize.com/api/v1/tools/update_client_brief" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","overview":"string","goal":"string","positioning":"string","audience":"string","voice":"string","add":[{"kind":"competitor","title":"string","body":"string","url":"string"}],"update":[{"id":"string","title":"string","body":"string","url":"string"}],"remove":["string"]}'
TypeScript
const res = await fetch('https://seolyticize.com/api/v1/tools/update_client_brief', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","overview":"string","goal":"string","positioning":"string","audience":"string","voice":"string","add":[{"kind":"competitor","title":"string","body":"string","url":"string"}],"update":[{"id":"string","title":"string","body":"string","url":"string"}],"remove":["string"]}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/update_client_brief",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "overview": "string", "goal": "string", "positioning": "string", "audience": "string", "voice": "string", "add": [{"kind": "competitor", "title": "string", "body": "string", "url": "string"}], "update": [{"id": "string", "title": "string", "body": "string", "url": "string"}], "remove": ["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/update_client_brief", strings.NewReader(`{"clientId":"string","overview":"string","goal":"string","positioning":"string","audience":"string","voice":"string","add":[{"kind":"competitor","title":"string","body":"string","url":"string"}],"update":[{"id":"string","title":"string","body":"string","url":"string"}],"remove":["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/update_client_brief');
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","overview":"string","goal":"string","positioning":"string","audience":"string","voice":"string","add":[{"kind":"competitor","title":"string","body":"string","url":"string"}],"update":[{"id":"string","title":"string","body":"string","url":"string"}],"remove":["string"]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/update_client_brief')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","overview":"string","goal":"string","positioning":"string","audience":"string","voice":"string","add":[{"kind":"competitor","title":"string","body":"string","url":"string"}],"update":[{"id":"string","title":"string","body":"string","url":"string"}],"remove":["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/update_client_brief"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"overview\":\"string\",\"goal\":\"string\",\"positioning\":\"string\",\"audience\":\"string\",\"voice\":\"string\",\"add\":[{\"kind\":\"competitor\",\"title\":\"string\",\"body\":\"string\",\"url\":\"string\"}],\"update\":[{\"id\":\"string\",\"title\":\"string\",\"body\":\"string\",\"url\":\"string\"}],\"remove\":[\"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