Update Prompt Personas
curl --request PATCH \
--url https://app.surfacd.com/api/v1/projects/{project}/prompts/personas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompts": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"personas": [
"<string>"
]
}
'import requests
url = "https://app.surfacd.com/api/v1/projects/{project}/prompts/personas"
payload = {
"prompts": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"personas": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompts: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], personas: ['<string>']})
};
fetch('https://app.surfacd.com/api/v1/projects/{project}/prompts/personas', 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://app.surfacd.com/api/v1/projects/{project}/prompts/personas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'prompts' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'personas' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.surfacd.com/api/v1/projects/{project}/prompts/personas"
payload := strings.NewReader("{\n \"prompts\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"personas\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://app.surfacd.com/api/v1/projects/{project}/prompts/personas")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompts\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"personas\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surfacd.com/api/v1/projects/{project}/prompts/personas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompts\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"personas\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"prompts": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"keyword": "<string>",
"status": "suggestion",
"search_volume": 123,
"topic": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"persona": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"source_prompt_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona_prompts": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
],
"buying_stage": "awareness",
"country": {
"code": "<string>",
"name": "<string>"
},
"tags": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "gray"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"message": "<string>",
"errors": {}
}Prompts
Update Prompt Personas
Adds, replaces or removes the personas a project’s prompts are asked as, as the Prompts page’s bulk persona actions do. Each prompt is asked as a persona through a prompt of its own (a persona variant); selecting a persona variant selects the prompt it was created from.
addalso asks each prompt as the listed personas.replaceasks each prompt as exactly the listed personas, deleting its variants asked as any other.removestops asking each prompt as the listed personas by deleting their variants.
Deleted variants and their history leave every report. Personas are UUIDs or names (names are case-insensitive) of the project’s personas. Every variant added counts towards the prompt limit and credits (replace counts only those beyond the ones it deletes), so when they don’t fit the request is refused with a 422 on prompts and nothing changes. Only active prompts can be asked as personas.
PATCH
/
api
/
v1
/
projects
/
{project}
/
prompts
/
personas
Update Prompt Personas
curl --request PATCH \
--url https://app.surfacd.com/api/v1/projects/{project}/prompts/personas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompts": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"personas": [
"<string>"
]
}
'import requests
url = "https://app.surfacd.com/api/v1/projects/{project}/prompts/personas"
payload = {
"prompts": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"personas": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompts: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], personas: ['<string>']})
};
fetch('https://app.surfacd.com/api/v1/projects/{project}/prompts/personas', 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://app.surfacd.com/api/v1/projects/{project}/prompts/personas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'prompts' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'personas' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.surfacd.com/api/v1/projects/{project}/prompts/personas"
payload := strings.NewReader("{\n \"prompts\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"personas\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://app.surfacd.com/api/v1/projects/{project}/prompts/personas")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompts\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"personas\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surfacd.com/api/v1/projects/{project}/prompts/personas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompts\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"personas\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"prompts": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"keyword": "<string>",
"status": "suggestion",
"search_volume": 123,
"topic": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"persona": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"source_prompt_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona_prompts": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
],
"buying_stage": "awareness",
"country": {
"code": "<string>",
"name": "<string>"
},
"tags": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "gray"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"message": "<string>",
"errors": {}
}Authorizations
Body
application/json