White-label an App Audit report with your branding (Studio) or switch it back, and set its label (free).

PATCHhttps://api.appgoat.ai/v1/audits/{id}

FreeoperationId updateAudit

white_label: true re-applies your current branding (use it after changing the branding), false shows the standard AppGoat report. 402 plan_limit for white_label on plans without white-label audits.

Request

curl -X PATCH "https://api.appgoat.ai/v1/audits/123" \
  -H "x-api-key: $APPGOAT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"white_label":false,"label":"string"}'

const res = await fetch("https://api.appgoat.ai/v1/audits/123", {
  method: 'PATCH',
  headers: {
    "x-api-key": process.env.APPGOAT_API_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({"white_label":false,"label":"string"}),
});
const { data, meta } = await res.json();

import os, requests

res = requests.patch(
    "https://api.appgoat.ai/v1/audits/123",
    headers={"x-api-key": os.environ["APPGOAT_API_KEY"]},
    json={"white_label":False,"label":"string"}
)
body = res.json()

Path parameters

idstringrequired

Request body

JSON, required.

white_labelboolean

labelstring | null

Response

200 with data: Audit. See the envelope for meta.

idstring

slugstring

urlstring

Shareable report page (not indexed by search engines).

status"queued" | "running" | "batched" | "done" | "failed"

storeStore

app_idstring

countrystring

mode"full" | "lite"

titlestring | null

icon_urlstring | null

scoreinteger | null

white_labelboolean

The report page carries your branding.

brandingany

labelstring | null

reportany

findingsFinding[]

Available as soon as the facts are gathered.

factsobject

Only with include=facts: listing, ratings, reviews, keywords (probe), competitors, localization, changes, gaps.

credits_chargedinteger

freeboolean

This was the organization's free first audit.

errorstring | null

created_atstring

finished_atstring | null

Example

{
  "data": {
    "id": "aud_3fK9aQ2mXc81LpRt",
    "slug": "string",
    "url": "https://appgoat.ai",
    "status": "queued",
    "store": "apple",
    "app_id": "324684580",
    "country": "us",
    "mode": "full",
    "title": "Spotify: Music and Podcasts",
    "icon_url": "string",
    "score": 1,
    "white_label": false,
    "branding": null,
    "label": "string",
    "report": null,
    "findings": [
      {
        "id": "string",
        "type": "striking_distance",
        "section": "metadata",
        "severity": "high",
        "title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
        "evidence": {},
        "fix": "string",
        "playbook": "string"
      }
    ],
    "facts": {},
    "credits_charged": 1,
    "free": false,
    "error": "string",
    "created_at": "2026-10-22T10:00:00Z",
    "finished_at": "2026-10-22T10:00:00Z"
  },
  "meta": {
    "credits_used": 0,
    "credits_remaining": 9981,
    "request_id": "req_123"
  }
}

Status codes

200

The updated audit.

400invalid_param

A parameter is missing or invalid (error.param names it).

401invalid_api_key

Missing or invalid API key.

402insufficient_creditsplan_limit

insufficient_credits (the call costs more than you have left; nothing was done) or plan_limit (a feature of a higher plan).

404not_found

Not found.

429rate_limited

Too many requests per second for your plan.