Update Prompt Tags
curl --request PATCH \
--url https://app.surfacd.com/api/v1/projects/{project}/prompts/tags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompts": [
{
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sync": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"remove": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
}
'import requests
url = "https://app.surfacd.com/api/v1/projects/{project}/prompts/tags"
payload = { "prompts": [
{
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sync": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"remove": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
] }
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: [
{
prompt: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sync: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
remove: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
]
})
};
fetch('https://app.surfacd.com/api/v1/projects/{project}/prompts/tags', 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/tags",
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' => [
[
'prompt' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sync' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'remove' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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/tags"
payload := strings.NewReader("{\n \"prompts\": [\n {\n \"prompt\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sync\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\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/tags")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompts\": [\n {\n \"prompt\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sync\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surfacd.com/api/v1/projects/{project}/prompts/tags")
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 {\n \"prompt\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sync\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"prompts": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"keyword": "<string>",
"search_volume": 123,
"topic": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"country": {
"code": "<string>",
"name": "<string>"
},
"tags": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Prompts
Update Prompt Tags
Bulk-updates tags across one or more of a project’s prompts. Each entry targets a prompt by UUID and either replaces its tags wholesale (sync) or applies incremental changes (add / remove). sync cannot be combined with add/remove, and each entry must specify at least one of the three. Tags are referenced by UUID and must already exist on the project; use /api/v1/projects/{project}/tags to create or list them. The whole request is applied atomically.
PATCH
/
api
/
v1
/
projects
/
{project}
/
prompts
/
tags
Update Prompt Tags
curl --request PATCH \
--url https://app.surfacd.com/api/v1/projects/{project}/prompts/tags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompts": [
{
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sync": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"remove": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
}
'import requests
url = "https://app.surfacd.com/api/v1/projects/{project}/prompts/tags"
payload = { "prompts": [
{
"prompt": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sync": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"remove": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
] }
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: [
{
prompt: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sync: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
remove: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
]
})
};
fetch('https://app.surfacd.com/api/v1/projects/{project}/prompts/tags', 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/tags",
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' => [
[
'prompt' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sync' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'remove' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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/tags"
payload := strings.NewReader("{\n \"prompts\": [\n {\n \"prompt\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sync\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\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/tags")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompts\": [\n {\n \"prompt\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sync\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surfacd.com/api/v1/projects/{project}/prompts/tags")
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 {\n \"prompt\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sync\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"prompts": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"keyword": "<string>",
"search_volume": 123,
"topic": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"country": {
"code": "<string>",
"name": "<string>"
},
"tags": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Authorizations
Team API key created in Team Settings. Use it with URLs for the same team.
Path Parameters
Project UUID.
Body
application/json
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Response
The affected prompts with their resulting tags.
The affected prompts with their resulting tag sets.
Show child attributes
Show child attributes
⌘I