Partially update a project

Updates an allowlisted subset of project fields. At least one allowed field must be present in the body. Project status, ownership, and credits are NOT updatable via this endpoint.

Allowed fields: clientName, industry, companySize, description, currency.

Validation:

• description must be a string when present and is capped at 5,000 characters.
• An empty body (no allowed fields) returns 400 EMPTY_PATCH.
• A non-string description returns 400 INVALID_DESCRIPTION_TYPE.
• A description over 5,000 chars returns 400 DESCRIPTION_TOO_LONG.

Returns the updated project (camelCase, same shape as Project). Returns 404 if the project does not exist or does not belong to the caller.

Requires: an audit-capable write plan, AND a PAT carrying the write scope (PATs only). Browser sessions implicitly have all scopes.

PATCH /api/projects/{id}

Partially update a project

cURL

curl --request PATCH \
  --url https://app.auditynow.com/api/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.",
  "companySize": "500-1000"
}
'

import requests

url = "https://app.auditynow.com/api/projects/{id}"

payload = {
    "description": "Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.",
    "companySize": "500-1000"
}
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({
    description: 'Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.',
    companySize: '500-1000'
  })
};

fetch('https://app.auditynow.com/api/projects/{id}', 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.auditynow.com/api/projects/{id}",
  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([
    'description' => 'Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.',
    'companySize' => '500-1000'
  ]),
  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.auditynow.com/api/projects/{id}"

	payload := strings.NewReader("{\n  \"description\": \"Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.\",\n  \"companySize\": \"500-1000\"\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.auditynow.com/api/projects/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.\",\n  \"companySize\": \"500-1000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/projects/{id}")

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  \"description\": \"Mid-market manufacturer evaluating AI transformation readiness. Updated after intake call.\",\n  \"companySize\": \"500-1000\"\n}"

response = http.request(request)
puts response.read_body

200

Example

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientName": "<string>",
  "industry": "<string>",
  "companySize": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "currency": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Path Parameters

id · string<uuid> · required

The project's UUID.

Body

application/json

All fields optional. At least ONE must be present, an empty body returns 400 EMPTY_PATCH. Status, ownership, and credits are not updatable here.

clientName · string

Required string length: 1 - 200

industry · string

Required string length: 1 - 100

companySize · string

Maximum string length: 50

description · string

Up to 5000 characters. Non-string values return 400 INVALID_DESCRIPTION_TYPE.

Maximum string length: 5000

currency · string

ISO 4217 currency code.

Required string length: 3

Response

200

application/json

Project updated

id · string<uuid> · required

clientName · string · required

industry · string · required

companySize · string · required

status · enum<string> · required

Lifecycle state of an audit project.

Available options: setup, analysis, interviews, complete, archived

createdAt · string<date-time> · required

description · string | null

currency · string

updatedAt · string<date-time>