Skip to main content
PATCH
/
api
/
v1
/
projects
/
{project}
Update Project
curl --request PATCH \
  --url https://app.surfacd.com/api/v1/projects/{project} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "default_country_code": "<string>",
  "prompt_limit": 500,
  "services": [
    "<string>"
  ]
}
'
import requests

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

payload = {
"name": "<string>",
"default_country_code": "<string>",
"prompt_limit": 500,
"services": ["<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({
name: '<string>',
default_country_code: '<string>',
prompt_limit: 500,
services: ['<string>']
})
};

fetch('https://app.surfacd.com/api/v1/projects/{project}', 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}",
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([
'name' => '<string>',
'default_country_code' => '<string>',
'prompt_limit' => 500,
'services' => [
'<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}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"default_country_code\": \"<string>\",\n \"prompt_limit\": 500,\n \"services\": [\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}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"default_country_code\": \"<string>\",\n \"prompt_limit\": 500,\n \"services\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"name\": \"<string>\",\n \"default_country_code\": \"<string>\",\n \"prompt_limit\": 500,\n \"services\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "pitch_ends_at": "2023-11-07T05:31:56Z",
  "prompt_limit": 123,
  "archived_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "default_country": {
    "code": "<string>",
    "name": "<string>"
  },
  "primary_brand": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "domain": "<string>",
    "brand_aliases": [
      "<string>"
    ]
  },
  "services": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "display_name": "<string>",
      "provider": "<string>"
    }
  ],
  "share": {
    "enabled": true,
    "share_url": "<string>",
    "password_protected": true
  }
}
{
"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.

Body

application/json

Partial update. Only the fields present are applied.

name
string
Maximum string length: 255
check_frequency
enum<string>
Available options:
manual,
monthly,
weekly,
daily
default_country_code
string

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

prompt_limit
integer | null
Required range: 1 <= x <= 1000
services
string[]

Replaces the monitored services. Each entry may be either a service UUID or provider slug such as chatgpt or perplexity.

Minimum array length: 1
primary_brand
object

Primary brand changes. name is required whenever primary_brand is supplied; domain and aliases are optional.

Response

The updated project.

uuid
string<uuid>
required
name
string
required
check_frequency
enum<string>
required
Available options:
manual,
monthly,
weekly,
daily
project_type
enum<string>
required

Project type. pitch projects run a fixed 7-day collection window and do not consume credits.

Available options:
standard,
pitch
pitch_ends_at
string<date-time> | null
required

End of the 7-day pitch collection window. Only set for pitch projects once their first collection run starts; always null for standard projects. Read-only.

prompt_limit
integer
required

Resolved prompt limit. Falls back to the team default when not explicitly set on the project.

archived_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
default_country
object | null
required
primary_brand
object | null
required
services
object[]
required

Active services (AI platforms) enabled for this project.

share
object
required