Set Project Profile
curl --request PUT \
--url https://api.peec.ai/customer/v1/project-profile \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"occupation": "<string>",
"industry": "<string>",
"brand_presentation": [
"<string>"
],
"brandPresentation": [
"<string>"
],
"products_and_services": [
"<string>"
],
"productsAndServices": [
"<string>"
],
"target_markets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"targetMarkets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"audience_distribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
},
"audienceDistribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
}
}
'import requests
url = "https://api.peec.ai/customer/v1/project-profile"
payload = {
"occupation": "<string>",
"industry": "<string>",
"brand_presentation": ["<string>"],
"brandPresentation": ["<string>"],
"products_and_services": ["<string>"],
"productsAndServices": ["<string>"],
"target_markets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"targetMarkets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"audience_distribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
},
"audienceDistribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
occupation: '<string>',
industry: '<string>',
brand_presentation: ['<string>'],
brandPresentation: ['<string>'],
products_and_services: ['<string>'],
productsAndServices: ['<string>'],
target_markets: [{location: '<string>', osm_id: '<string>', osmId: '<string>'}],
targetMarkets: [{location: '<string>', osm_id: '<string>', osmId: '<string>'}],
audience_distribution: {
simple_recommendation_seeker: 4503599627370495,
simpleRecommendationSeeker: 4503599627370495,
informed_shopper: 4503599627370495,
informedShopper: 4503599627370495,
evaluative_researcher: 4503599627370495,
evaluativeResearcher: 4503599627370495
},
audienceDistribution: {
simple_recommendation_seeker: 4503599627370495,
simpleRecommendationSeeker: 4503599627370495,
informed_shopper: 4503599627370495,
informedShopper: 4503599627370495,
evaluative_researcher: 4503599627370495,
evaluativeResearcher: 4503599627370495
}
})
};
fetch('https://api.peec.ai/customer/v1/project-profile', 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.peec.ai/customer/v1/project-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'occupation' => '<string>',
'industry' => '<string>',
'brand_presentation' => [
'<string>'
],
'brandPresentation' => [
'<string>'
],
'products_and_services' => [
'<string>'
],
'productsAndServices' => [
'<string>'
],
'target_markets' => [
[
'location' => '<string>',
'osm_id' => '<string>',
'osmId' => '<string>'
]
],
'targetMarkets' => [
[
'location' => '<string>',
'osm_id' => '<string>',
'osmId' => '<string>'
]
],
'audience_distribution' => [
'simple_recommendation_seeker' => 4503599627370495,
'simpleRecommendationSeeker' => 4503599627370495,
'informed_shopper' => 4503599627370495,
'informedShopper' => 4503599627370495,
'evaluative_researcher' => 4503599627370495,
'evaluativeResearcher' => 4503599627370495
],
'audienceDistribution' => [
'simple_recommendation_seeker' => 4503599627370495,
'simpleRecommendationSeeker' => 4503599627370495,
'informed_shopper' => 4503599627370495,
'informedShopper' => 4503599627370495,
'evaluative_researcher' => 4503599627370495,
'evaluativeResearcher' => 4503599627370495
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.peec.ai/customer/v1/project-profile"
payload := strings.NewReader("{\n \"occupation\": \"<string>\",\n \"industry\": \"<string>\",\n \"brand_presentation\": [\n \"<string>\"\n ],\n \"brandPresentation\": [\n \"<string>\"\n ],\n \"products_and_services\": [\n \"<string>\"\n ],\n \"productsAndServices\": [\n \"<string>\"\n ],\n \"target_markets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"targetMarkets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"audience_distribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n },\n \"audienceDistribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.put("https://api.peec.ai/customer/v1/project-profile")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"occupation\": \"<string>\",\n \"industry\": \"<string>\",\n \"brand_presentation\": [\n \"<string>\"\n ],\n \"brandPresentation\": [\n \"<string>\"\n ],\n \"products_and_services\": [\n \"<string>\"\n ],\n \"productsAndServices\": [\n \"<string>\"\n ],\n \"target_markets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"targetMarkets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"audience_distribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n },\n \"audienceDistribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/project-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"occupation\": \"<string>\",\n \"industry\": \"<string>\",\n \"brand_presentation\": [\n \"<string>\"\n ],\n \"brandPresentation\": [\n \"<string>\"\n ],\n \"products_and_services\": [\n \"<string>\"\n ],\n \"productsAndServices\": [\n \"<string>\"\n ],\n \"target_markets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"targetMarkets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"audience_distribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n },\n \"audienceDistribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n }\n}"
response = http.request(request)
puts response.read_body{}{
"message": "<string>"
}{
"message": "<string>"
}Project
Set Project Profile
Replace the project’s brand profile. All fields are required — the entire profile is overwritten. Triggers a background refresh of prompt suggestions. Audience distribution percentages must sum to 100. The project’s display name is not part of the profile and cannot be changed via this endpoint. Returns 403 while the project is in onboarding.
PUT
/
project-profile
Set Project Profile
curl --request PUT \
--url https://api.peec.ai/customer/v1/project-profile \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"occupation": "<string>",
"industry": "<string>",
"brand_presentation": [
"<string>"
],
"brandPresentation": [
"<string>"
],
"products_and_services": [
"<string>"
],
"productsAndServices": [
"<string>"
],
"target_markets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"targetMarkets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"audience_distribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
},
"audienceDistribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
}
}
'import requests
url = "https://api.peec.ai/customer/v1/project-profile"
payload = {
"occupation": "<string>",
"industry": "<string>",
"brand_presentation": ["<string>"],
"brandPresentation": ["<string>"],
"products_and_services": ["<string>"],
"productsAndServices": ["<string>"],
"target_markets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"targetMarkets": [
{
"location": "<string>",
"osm_id": "<string>",
"osmId": "<string>"
}
],
"audience_distribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
},
"audienceDistribution": {
"simple_recommendation_seeker": 4503599627370495,
"simpleRecommendationSeeker": 4503599627370495,
"informed_shopper": 4503599627370495,
"informedShopper": 4503599627370495,
"evaluative_researcher": 4503599627370495,
"evaluativeResearcher": 4503599627370495
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
occupation: '<string>',
industry: '<string>',
brand_presentation: ['<string>'],
brandPresentation: ['<string>'],
products_and_services: ['<string>'],
productsAndServices: ['<string>'],
target_markets: [{location: '<string>', osm_id: '<string>', osmId: '<string>'}],
targetMarkets: [{location: '<string>', osm_id: '<string>', osmId: '<string>'}],
audience_distribution: {
simple_recommendation_seeker: 4503599627370495,
simpleRecommendationSeeker: 4503599627370495,
informed_shopper: 4503599627370495,
informedShopper: 4503599627370495,
evaluative_researcher: 4503599627370495,
evaluativeResearcher: 4503599627370495
},
audienceDistribution: {
simple_recommendation_seeker: 4503599627370495,
simpleRecommendationSeeker: 4503599627370495,
informed_shopper: 4503599627370495,
informedShopper: 4503599627370495,
evaluative_researcher: 4503599627370495,
evaluativeResearcher: 4503599627370495
}
})
};
fetch('https://api.peec.ai/customer/v1/project-profile', 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.peec.ai/customer/v1/project-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'occupation' => '<string>',
'industry' => '<string>',
'brand_presentation' => [
'<string>'
],
'brandPresentation' => [
'<string>'
],
'products_and_services' => [
'<string>'
],
'productsAndServices' => [
'<string>'
],
'target_markets' => [
[
'location' => '<string>',
'osm_id' => '<string>',
'osmId' => '<string>'
]
],
'targetMarkets' => [
[
'location' => '<string>',
'osm_id' => '<string>',
'osmId' => '<string>'
]
],
'audience_distribution' => [
'simple_recommendation_seeker' => 4503599627370495,
'simpleRecommendationSeeker' => 4503599627370495,
'informed_shopper' => 4503599627370495,
'informedShopper' => 4503599627370495,
'evaluative_researcher' => 4503599627370495,
'evaluativeResearcher' => 4503599627370495
],
'audienceDistribution' => [
'simple_recommendation_seeker' => 4503599627370495,
'simpleRecommendationSeeker' => 4503599627370495,
'informed_shopper' => 4503599627370495,
'informedShopper' => 4503599627370495,
'evaluative_researcher' => 4503599627370495,
'evaluativeResearcher' => 4503599627370495
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.peec.ai/customer/v1/project-profile"
payload := strings.NewReader("{\n \"occupation\": \"<string>\",\n \"industry\": \"<string>\",\n \"brand_presentation\": [\n \"<string>\"\n ],\n \"brandPresentation\": [\n \"<string>\"\n ],\n \"products_and_services\": [\n \"<string>\"\n ],\n \"productsAndServices\": [\n \"<string>\"\n ],\n \"target_markets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"targetMarkets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"audience_distribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n },\n \"audienceDistribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.put("https://api.peec.ai/customer/v1/project-profile")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"occupation\": \"<string>\",\n \"industry\": \"<string>\",\n \"brand_presentation\": [\n \"<string>\"\n ],\n \"brandPresentation\": [\n \"<string>\"\n ],\n \"products_and_services\": [\n \"<string>\"\n ],\n \"productsAndServices\": [\n \"<string>\"\n ],\n \"target_markets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"targetMarkets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"audience_distribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n },\n \"audienceDistribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/project-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"occupation\": \"<string>\",\n \"industry\": \"<string>\",\n \"brand_presentation\": [\n \"<string>\"\n ],\n \"brandPresentation\": [\n \"<string>\"\n ],\n \"products_and_services\": [\n \"<string>\"\n ],\n \"productsAndServices\": [\n \"<string>\"\n ],\n \"target_markets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"targetMarkets\": [\n {\n \"location\": \"<string>\",\n \"osm_id\": \"<string>\",\n \"osmId\": \"<string>\"\n }\n ],\n \"audience_distribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n },\n \"audienceDistribution\": {\n \"simple_recommendation_seeker\": 4503599627370495,\n \"simpleRecommendationSeeker\": 4503599627370495,\n \"informed_shopper\": 4503599627370495,\n \"informedShopper\": 4503599627370495,\n \"evaluative_researcher\": 4503599627370495,\n \"evaluativeResearcher\": 4503599627370495\n }\n}"
response = http.request(request)
puts response.read_body{}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
APIKeyHeaderAPIKeyQueryBearerAuth
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
The role or perspective the profile speaks from, e.g. 'Founder'.
Minimum string length:
1The industry the brand operates in, e.g. 'SaaS'.
Minimum string length:
1Short statements describing how the brand presents itself, e.g. ["Premium eco-friendly cleaning products"].
Minimum array length:
1Minimum string length:
1Deprecated camelCase alias of brand_presentation, e.g. ["Premium eco-friendly cleaning products"].
Minimum array length:
1Minimum string length:
1The products and services the brand offers, e.g. ["CRM software","Analytics dashboard"].
Minimum array length:
1Minimum string length:
1Deprecated camelCase alias of products_and_services, e.g. ["CRM software","Analytics dashboard"].
Minimum array length:
1Minimum string length:
1The geographic markets the brand targets, e.g. [{"market_size":"National","location":"United States"}].
Minimum array length:
1Show child attributes
Show child attributes
Deprecated camelCase alias of target_markets, e.g. [{"marketSize":"National","location":"United States"}].
Minimum array length:
1Show child attributes
Show child attributes
Percentage split of the audience across buyer types (must sum to 100), e.g. {"simple_recommendation_seeker":40,"informed_shopper":40,"evaluative_researcher":20}.
Show child attributes
Show child attributes
Deprecated camelCase alias of audience_distribution (must sum to 100), e.g. {"simpleRecommendationSeeker":40,"informedShopper":40,"evaluativeResearcher":20}.
Show child attributes
Show child attributes
Response
Project profile set successfully
Project profile set successfully
⌘I