Skip to main content
PATCH
/
api
/
v1
/
projects
/
{project}
/
prompts
/
{prompt}
Update Prompt
curl --request PATCH \
  --url https://app.surfacd.com/api/v1/projects/{project}/prompts/{prompt} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "country_code": "<string>",
  "topic": "<string>"
}
'
import requests

url = "https://app.surfacd.com/api/v1/projects/{project}/prompts/{prompt}"

payload = {
"text": "<string>",
"country_code": "<string>",
"topic": "<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({text: '<string>', country_code: '<string>', topic: '<string>'})
};

fetch('https://app.surfacd.com/api/v1/projects/{project}/prompts/{prompt}', 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/{prompt}",
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([
'text' => '<string>',
'country_code' => '<string>',
'topic' => '<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/{prompt}"

payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"country_code\": \"<string>\",\n \"topic\": \"<string>\"\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/{prompt}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"country_code\": \"<string>\",\n \"topic\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.surfacd.com/api/v1/projects/{project}/prompts/{prompt}")

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 \"text\": \"<string>\",\n \"country_code\": \"<string>\",\n \"topic\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

project
string<uuid>
required

Project UUID.

prompt
string<uuid>
required

Prompt UUID.

Body

application/json

Partial update. Only the fields present are applied.

text
string
Maximum string length: 700
country_code
string

ISO 3166-1 alpha-2 code of an active country.

topic
string | null

Topic name (created if it doesn't exist), or null to clear the topic.

Maximum string length: 255
status
enum<string>

Activating is subject to the project's prompt limit and the team's credits.

Available options:
active,
inactive

Response

The updated prompt.

uuid
string<uuid>
required
text
string
required

The prompt text.

keyword
string | null
required
status
enum<string>
required
Available options:
suggestion,
declined,
inactive,
active
search_volume
integer | null
required

Most recent search volume for the prompt's keyword, when known.

topic
object | null
required
country
object
required
tags
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required