# ENJ Management API endpoint inventory

API: https://api.enjdigital.com
Source commit: f0eee8a3239ff2e2736ec18b4017f5ee5cd062d8
Generated: 2026-11-20T08:50:18.465Z

This is an inventory, not permission to execute. Request schemas are partial. Use /llms.txt and /guide.md first. Provider callbacks/internal bridges are not agent commands. The private voice pilot remains disabled.

## POST /api/acquisition-funnel/events

Area: acquisition-funnel. Mutation or action; explicit authority required.
Access: Visitor/bridge controls; not a general agent API. Additional scope rules may apply.
Source: apps/api/src/acquisition-funnel/routes.ts:36

### body

Schema not fully extracted. Inspect current source.

## GET /api/acquisition-funnel/readiness

Area: acquisition-funnel. Read method; may have cache or collection side effects.
Access: Visitor/bridge controls; not a general agent API. Additional scope rules may apply.
Source: apps/api/src/acquisition-funnel/routes.ts:20

## POST /api/acquisition-funnel/submit

Area: acquisition-funnel. Mutation or action; explicit authority required.
Access: Visitor/bridge controls; not a general agent API. Additional scope rules may apply.
Source: apps/api/src/acquisition-funnel/routes.ts:46

### body

Schema not fully extracted. Inspect current source.

## GET /api/ads-manager/adsets/:adSetId/setup

Area: ads-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:152

### query

Schema not fully extracted. Inspect current source.

### params

- adSetId: string; required

## GET /api/ads-manager/clients/:clientId/details

Area: ads-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:129

### params

- clientId: string; required

### query

Schema not fully extracted. Inspect current source.

## POST /api/ads-manager/clients/:clientId/journal

Area: ads-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:191

### params

- clientId: string; required

### body

- categories: array; required
- details: string; optional
- context: object; optional, nullable

## GET /api/ads-manager/creatives

Area: ads-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:75

### query

Schema not fully extracted. Inspect current source.

## GET /api/ads-manager/creatives/:id/image

Area: ads-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:94

### params

- id: string; required

## GET /api/ads-manager/journal

Area: ads-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:174

### query

- clientId: string; optional
- statuses: string; optional
- category: string; optional; allowed: new_ads_launched, creative_or_copy_updated, targeting_updated, budget_updated, campaign_or_adset_updated, ads_paused_or_restarted, optimization_made, other
- authorEmail: string; optional
- q: string; optional
- cursor: string; optional
- limit: integer; optional

## DELETE /api/ads-manager/journal/:entryId

Area: ads-manager. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:226

### params

- entryId: string; required

## PATCH /api/ads-manager/journal/:entryId

Area: ads-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:209

### params

- entryId: string; required

### body

- categories: array; required
- details: string; optional
- context: object; optional, nullable

## GET /api/ads-manager/overview

Area: ads-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:57

### query

Schema not fully extracted. Inspect current source.

## POST /api/ads-manager/refresh

Area: ads-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/ads-manager/routes.ts:112

### body

Schema not fully extracted. Inspect current source.

## GET /api/agencies

Area: agencies. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:101

## POST /api/agencies

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:109

### body

- agencyName: string; required
- slug: string; required
- logoUrl: string; optional
- faviconUrl: string; optional
- themeColor: string; optional
- accentColor: string; optional
- websiteUrl: string; optional
- supportName: string; optional
- supportEmail: string; optional
- communicationTemplates: object; optional

## GET /api/agencies/:id

Area: agencies. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:113

### params

- id: string; required

## PATCH /api/agencies/:id

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:118

### params

- id: string; required

### body

- agencyName: string; optional
- slug: string; optional
- logoUrl: string; optional
- faviconUrl: string; optional
- themeColor: string; optional
- accentColor: string; optional
- websiteUrl: string; optional
- supportName: string; optional
- supportEmail: string; optional
- communicationTemplates: object; optional
- status: string; optional; allowed: active, inactive

## POST /api/agencies/:id/clients

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:163

### params

- id: string; required

### body

- clientId: string; required

## GET /api/agencies/:id/integrations

Area: agencies. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:263

### params

- id: string; required

## DELETE /api/agencies/:id/integrations/:key

Area: agencies. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:288

### params

- id: string; required
- key: string; required; allowed: slack, meta, stripe, ghl

## PUT /api/agencies/:id/integrations/:key

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:268

### params

- id: string; required
- key: string; required; allowed: slack, meta, stripe, ghl

### body

- token: string; optional; sensitive, never log
- secretKey: string; optional; sensitive, never log
- webhookSecret: string; optional; sensitive, never log
- privateKey: string; optional
- locationId: string; optional

## POST /api/agencies/:id/integrations/fathom/recheck

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:294

### params

- id: string; required

## POST /api/agencies/:id/logo

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:142

### params

- id: string; required

### body

- fileName: string; required
- dataUrl: string; required
- useAsFavicon: boolean; optional

## POST /api/agencies/:id/members

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:170

### params

- id: string; required

### body

- name: string; optional
- email: string; required
- role: string; optional; allowed: collaborator, viewer
- permissions: object; optional

## DELETE /api/agencies/:id/members/:memberId

Area: agencies. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:221

### params

- id: string; required
- memberId: string; required

## PATCH /api/agencies/:id/members/:memberId

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:232

### params

- id: string; required
- memberId: string; required

### body

- role: string; optional; allowed: collaborator, viewer
- permissions: object; optional

## DELETE /api/agencies/:id/portal-domain

Area: agencies. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:136

### params

- id: string; required

## POST /api/agencies/:id/portal-domain

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:123

### params

- id: string; required

### body

- hostname: string; required

## POST /api/agencies/:id/portal-domain/recheck

Area: agencies. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:130

### params

- id: string; required

## GET /api/agencies/navigation

Area: agencies. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/agencies/routes.ts:86

### query

Schema not fully extracted. Inspect current source.

## GET /api/ai-agent/admin-config

Area: ai-agent. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:51

## PATCH /api/ai-agent/admin-config

Area: ai-agent. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:55

### body

- enabled: boolean; optional
- name: string; optional
- iconUrl: string; optional
- greeting: string; optional
- basePrompt: string; optional
- model: string; optional
- responseStyle: string; optional; allowed: concise, balanced, detailed
- connectedSources: object; optional

## POST /api/ai-agent/chat

Area: ai-agent. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:60

### body

- message: string; required
- threadId: string; optional, nullable

## POST /api/ai-agent/chat/stream

Area: ai-agent. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:70

### body

- message: string; required
- threadId: string; optional, nullable

## GET /api/ai-agent/config

Area: ai-agent. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:47

## POST /api/ai-agent/icon

Area: ai-agent. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:99

### body

- fileName: string; required
- dataUrl: string; required

## POST /api/auth/2fa/setup/verify

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:131

### body

- challengeId: string; required
- code: string; required
- trustBrowser: boolean; optional

## POST /api/auth/2fa/verify

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:144

### body

- challengeId: string; required
- code: string; required
- trustBrowser: boolean; optional

## POST /api/auth/forgot-password

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:157

### body

- email: string; required

## POST /api/auth/login

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:92

### body

- email: string; required
- password: string; required; sensitive, never log

## POST /api/auth/logout

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:197

## GET /api/auth/me

Area: auth. Read method; may have cache or collection side effects.
Access: Authenticated Management identity. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:202

## POST /api/auth/password-setup/complete

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:126

### body

- challengeId: string; required
- password: string; required; sensitive, never log

## GET /api/auth/portal-brand

Area: auth. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:86

### query

- host: string; required

## POST /api/auth/reset-password/complete

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:192

### body

- token: string; required; sensitive, never log
- password: string; required; sensitive, never log

## POST /api/auth/reset-password/validate

Area: auth. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/auth/routes.ts:174

### body

- token: string; required; sensitive, never log

## GET /api/authentication/accounts

Area: authentication. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/authentication/routes.ts:46

## POST /api/authentication/accounts

Area: authentication. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/authentication/routes.ts:50

### body

- label: string; required
- secret: string; required; sensitive, never log
- issuer: string; optional, nullable
- icon: string; optional; allowed: key, google, facebook, instagram, microsoft, apple, x, linkedin, slack, github
- visibleToRoles: array; optional, nullable
- period: integer; optional
- digits: integer; optional
- algorithm: string; optional; allowed: SHA1, SHA256, SHA512

## DELETE /api/authentication/accounts/:id

Area: authentication. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/authentication/routes.ts:68

### params

- id: string; required

## PATCH /api/authentication/accounts/:id

Area: authentication. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/authentication/routes.ts:58

### params

- id: string; required

### body

- label: string; optional
- secret: string; optional; sensitive, never log
- issuer: string; optional, nullable
- icon: string; optional; allowed: key, google, facebook, instagram, microsoft, apple, x, linkedin, slack, github
- visibleToRoles: array; optional, nullable
- period: integer; optional
- digits: integer; optional
- algorithm: string; optional; allowed: SHA1, SHA256, SHA512

## GET /api/automations

Area: automations. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:93

## PATCH /api/automations/:id

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:97

### params

- id: string; required

### body

- enabled: boolean; optional
- values: object; optional

## GET /api/automations/:id/activity

Area: automations. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:171

### params

- id: string; required

## GET /api/automations/activity

Area: automations. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:111

## POST /api/automations/custom

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:117

### body

Schema not fully extracted. Inspect current source.

## DELETE /api/automations/custom/:id

Area: automations. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:158

### params

- id: string; required

## GET /api/automations/custom/:id

Area: automations. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:123

### params

- id: string; required

## PATCH /api/automations/custom/:id

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:152

### params

- id: string; required

### body

- enabled: boolean; required

## POST /api/automations/custom/:id/discard

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:147

### params

- id: string; required

## PUT /api/automations/custom/:id/draft

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:128

### params

- id: string; required

### body

- name: string; optional
- draft: unknown; optional

## GET /api/automations/custom/:id/matches

Area: automations. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:135

### params

- id: string; required

## POST /api/automations/custom/:id/publish

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:140

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /api/automations/custom/:id/test

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:163

### params

- id: string; required

### body

- clientId: string; required

## PUT /api/automations/layout

Area: automations. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner. Additional scope rules may apply.
Source: apps/api/src/automations/routes.ts:105

### body

- folders: array; required
- sections: array; optional

## GET /api/billing/clients/:clientId/appointments

Area: billing. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:144

### params

- clientId: string; required

### query

- range: string; optional
- start: string; optional
- end: string; optional

## POST /api/billing/clients/:clientId/appointments/:appointmentId/report

Area: billing. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:178

### params

- clientId: string; required
- appointmentId: string; required

### body

- status: string; required; allowed: no_show, unqualified
- recordingUrl: string; optional
- details: string; optional

## POST /api/billing/clients/:clientId/journal

Area: billing. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:222

### params

- clientId: string; required

### body

- categories: array; required
- details: string; optional

## GET /api/billing/clients/:clientId/leads

Area: billing. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:161

### params

- clientId: string; required

### query

- range: string; optional
- start: string; optional
- end: string; optional

## GET /api/billing/journal

Area: billing. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:204

### query

- clientId: string; optional
- statuses: string; optional
- category: string; optional; allowed: poor_pickup_rate, not_qualified, other
- q: string; optional
- cursor: string; optional
- limit: integer; optional

## DELETE /api/billing/journal/:entryId

Area: billing. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:251

### params

- entryId: string; required

## PATCH /api/billing/journal/:entryId

Area: billing. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:236

### params

- entryId: string; required

### body

- categories: array; required
- details: string; optional

## GET /api/billing/overview

Area: billing. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:89

### query

- range: string; optional
- start: string; optional
- end: string; optional

## POST /api/billing/refresh

Area: billing. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter. Additional scope rules may apply.
Source: apps/api/src/billing/routes.ts:116

### body

Schema not fully extracted. Inspect current source.

## GET /api/client-context/calls

Area: client-context. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/client-context/routes.ts:29

### query

- clientId: string; required
- q: string; optional
- offset: integer; optional
- limit: integer; optional

## GET /api/client-context/calls/:recordingId

Area: client-context. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/client-context/routes.ts:42

### query

- clientId: string; required
- offset: integer; optional
- limit: integer; optional

### params

- recordingId: string; required

## GET /api/client-delivery/clients

Area: client-delivery. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/client-delivery/routes.ts:94

## PATCH /api/client-delivery/clients/:id

Area: client-delivery. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/client-delivery/routes.ts:121

### params

- id: string; required

### body

- clientName: string; optional
- primaryContactName: string; optional
- status: string; optional
- churnReason: string; optional
- reviewCallDate: string; optional
- kickoffCallDate: string; optional
- onboardingCallDate: string; optional
- newClientMessage: string; optional
- googleDrive: string; optional
- offerBuildout: string; optional
- a2pStatus: string; optional
- staticAds: string; optional
- buildGhl: string; optional
- setupPixel: string; optional
- updateClientPortal: string; optional
- landingPage: string; optional
- landingPageUrls: array; optional
- landingPageUrl: string; optional
- ghlLocationId: string; optional
- ghlPrivateKey: string; optional
- ghlAccount: string; optional
- metaAccountName: string; optional
- adAccountLink: string; optional
- metaPixelCode: string; optional
- pixelScript: string; optional
- clientWebsite: string; optional
- servicesOffered: string; optional
- targetNiche: string; optional
- targetAudience: string; optional
- callTakers: string; optional
- startEndDate: string; optional
- monthlyRetainer: number; optional, nullable
- setupFee: number; optional, nullable
- setupFeeCollected: number; optional, nullable
- dailyAdsBudget: number; optional, nullable
- clientDeal: string; optional
- contractSigned: boolean; optional, nullable
- needsSetter: string; optional
- setterAdded: boolean; optional
- assignedSetter: string; optional
- assignedSetterId: string; optional, nullable
- completedMeeting: string; optional
- meetingLocation: string; optional
- notes: string; optional

## GET /api/client-delivery/clients/:id/meta-tracking

Area: client-delivery. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, staff. Additional scope rules may apply.
Source: apps/api/src/client-delivery/metaTrackingRoutes.ts:19

### params

- id: string; required

## PATCH /api/client-delivery/clients/:id/meta-tracking

Area: client-delivery. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/client-delivery/metaTrackingRoutes.ts:25

### params

- id: string; required

### body

- pixelCode: string; optional
- datasetId: string; optional
- accessToken: string; optional, nullable; sensitive, never log
- expectedUpdatedAt: string; required, nullable

## POST /api/client-delivery/import/notion-csv

Area: client-delivery. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-delivery/routes.ts:140

### body

- csvText: string; required
- sourceName: string; optional

## GET /api/client-delivery/views/:view

Area: client-delivery. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/client-delivery/routes.ts:111

### params

- view: string; required; allowed: onboarding, strategy, setup-phase, client-board, setters, offer-billing, call-manager, access-control, all-clients

## DELETE /api/client-videos/:id

Area: client-videos. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:215

### params

- id: string; required

### body

- confirmation: string; required; allowed: DELETE

## PATCH /api/client-videos/:id

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:116

### params

- id: string; required

### body

- title: string; optional
- description: string; optional

## GET /api/client-videos/:id/analysis

Area: client-videos. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:179

### params

- id: string; required

## POST /api/client-videos/:id/analysis

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:185

### params

- id: string; required

## GET /api/client-videos/:id/download

Area: client-videos. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:167

### params

- id: string; required

## POST /api/client-videos/:id/finalize

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:144

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## GET /api/client-videos/:id/media

Area: client-videos. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:156

### params

- id: string; required

## POST /api/client-videos/:id/publish

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:191

### params

- id: string; required

## POST /api/client-videos/:id/unpublish

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:203

### params

- id: string; required

## POST /api/client-videos/:id/upload

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:129

### params

- id: string; required

### body

- fileName: string; required
- mimeType: string; required; allowed: video/mp4, video/quicktime, video/webm
- sizeBytes: integer; required

## GET /api/clients

Area: clients. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:120

### query

- compact: string; optional; allowed: true, false

## GET /api/clients/:clientId/videos

Area: client-videos. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:93

### params

- clientId: string; required

## POST /api/clients/:clientId/videos

Area: client-videos. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:102

### params

- clientId: string; required

### body

- title: string; required
- description: string; optional

## DELETE /api/clients/:id

Area: clients. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:450

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## PATCH /api/clients/:id

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:154

### params

- id: string; required

### body

- clientName: string; optional
- primaryContactName: string; optional
- status: string; optional
- churnReason: string; optional
- reviewCallDate: string; optional
- kickoffCallDate: string; optional
- onboardingCallDate: string; optional
- newClientMessage: string; optional
- googleDrive: string; optional
- offerBuildout: string; optional
- a2pStatus: string; optional
- staticAds: string; optional
- buildGhl: string; optional
- setupPixel: string; optional
- updateClientPortal: string; optional
- landingPage: string; optional
- landingPageUrls: array; optional
- landingPageUrl: string; optional
- ghlLocationId: string; optional
- ghlPrivateKey: string; optional
- ghlAccount: string; optional
- metaAccountName: string; optional
- adAccountLink: string; optional
- metaPixelCode: string; optional
- pixelScript: string; optional
- clientWebsite: string; optional
- servicesOffered: string; optional
- targetNiche: string; optional
- targetAudience: string; optional
- callTakers: string; optional
- startEndDate: string; optional
- monthlyRetainer: number; optional, nullable
- setupFee: number; optional, nullable
- setupFeeCollected: number; optional, nullable
- dailyAdsBudget: number; optional, nullable
- clientDeal: string; optional
- contractSigned: boolean; optional, nullable
- needsSetter: string; optional
- setterAdded: boolean; optional
- assignedSetter: string; optional
- assignedSetterId: string; optional, nullable
- completedMeeting: string; optional
- meetingLocation: string; optional
- notes: string; optional
- slackChannelUrl: string; optional, nullable

## GET /api/clients/:id/brand-dna

Area: clients. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:131

### params

- id: string; required

## PATCH /api/clients/:id/brand-dna

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:179

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## GET /api/clients/:id/brand-dna/assets/:assetId

Area: clients. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:207

### params

- id: string; required
- assetId: string; required

## POST /api/clients/:id/brand-dna/generate

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:193

### params

- id: string; required

## POST /api/clients/:id/campaigns

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:230

### params

- id: string; required

### body

- name: string; required

## DELETE /api/clients/:id/campaigns/:campaignId

Area: clients. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:344

### params

- id: string; required
- campaignId: string; required

### body

- confirmation: string; required; allowed: DELETE
- reason: string; optional

## PATCH /api/clients/:id/campaigns/:campaignId

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:244

### params

- id: string; required
- campaignId: string; required

### body

- name: string; optional
- status: string; optional
- churnReason: string; optional
- reviewCallDate: string; optional
- angle: string; optional
- offerBuildout: string; optional
- buildGhl: string; optional
- staticAds: string; optional
- landingPage: string; optional
- landingPageUrls: array; optional
- landingPageUrl: string; optional
- targetNiche: string; optional
- targetAudience: string; optional
- metaCampaignId: string; optional, nullable

## POST /api/clients/:id/campaigns/approve-strategy

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:311

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## PATCH /api/clients/:id/happiness

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:383

### params

- id: string; required

### body

- score: integer; required, nullable
- reason: string; optional

## POST /api/clients/:id/happiness/resolve-trigger

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:436

### params

- id: string; required

### body

- triggerClass: string; required

## POST /api/clients/:id/presence

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:463

### params

- id: string; required

### body

- field: string; required
- label: string; required
- state: string; required; allowed: editing, idle

## POST /api/clients/:id/slack-channel/test

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:478

### params

- id: string; required

### body

- channel: string; optional

## POST /api/clients/slack-channels/refresh

Area: clients. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/clients/routes.ts:143

### body

Schema not fully extracted. Inspect current source.

## GET /api/creative-generator/assets

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:72

### query

- clientId: string; optional

## DELETE /api/creative-generator/assets/:id

Area: creative-generator. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:128

### params

- id: string; required

## PATCH /api/creative-generator/assets/:id

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:120

### params

- id: string; required

### body

- status: string; required; allowed: candidate, kept, discarded

## GET /api/creative-generator/assets/:id/image

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:134

### params

- id: string; required

## GET /api/creative-generator/config

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:68

## POST /api/creative-generator/generate

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:94

### body

- clientId: string; required
- prompt: string; required
- presetId: string; optional, nullable
- model: string; optional
- count: integer; optional
- size: string; optional
- quality: string; optional
- referenceAssetId: string; optional, nullable

## GET /api/creative-generator/motion-ads/assets

Area: motion-ads. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:111

### query

- clientId: string; optional

## POST /api/creative-generator/motion-ads/assets

Area: motion-ads. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:116

### body

- clientId: string; required, nullable
- fileName: string; required
- dataUrl: string; required

## DELETE /api/creative-generator/motion-ads/assets/:id

Area: motion-ads. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:140

### params

- id: string; required

## GET /api/creative-generator/motion-ads/config

Area: motion-ads. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:66

## GET /api/creative-generator/motion-ads/files

Area: motion-ads. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:123

### query

- key: string; required
- download: string; optional

## GET /api/creative-generator/motion-ads/projects

Area: motion-ads. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:70

### query

- clientId: string; optional

## POST /api/creative-generator/motion-ads/projects

Area: motion-ads. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:75

### body

- clientId: string; required, nullable
- brief: string; required
- style: string; required; allowed: product, kinetic, editorial, glass, warm
- voiceId: string; required
- voiceName: string; required
- assetIds: array; required

## GET /api/creative-generator/motion-ads/projects/:id

Area: motion-ads. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:81

### params

- id: string; required

## POST /api/creative-generator/motion-ads/projects/:id/changes

Area: motion-ads. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:93

### params

- id: string; required

### body

- request: string; required

## POST /api/creative-generator/motion-ads/projects/:id/retry

Area: motion-ads. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:99

### params

- id: string; required

## PATCH /api/creative-generator/motion-ads/projects/:id/storyboard

Area: motion-ads. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:87

### params

- id: string; required

### body

- beats: array; required

## POST /api/creative-generator/motion-ads/projects/:id/versions

Area: motion-ads. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:105

### params

- id: string; required

## GET /api/creative-generator/motion-ads/voices

Area: motion-ads. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/motion-ads/routes.ts:68

## POST /api/creative-generator/presets

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:104

### body

- name: string; required
- prompt: string; required
- referenceAssetId: string; optional, nullable

## DELETE /api/creative-generator/presets/:id

Area: creative-generator. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:115

### params

- id: string; required

## PATCH /api/creative-generator/presets/:id

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:109

### params

- id: string; required

### body

- name: string; optional
- prompt: string; optional
- referenceAssetId: string; optional, nullable

## POST /api/creative-generator/reference-image

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:84

### body

- clientId: string; required
- fileName: string; required
- dataUrl: string; required

## GET /api/creative-generator/runs

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/routes.ts:78

### query

- clientId: string; optional

## GET /api/creative-generator/video-editor/config

Area: video-editor. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:151

## GET /api/creative-generator/video-editor/projects

Area: video-editor. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:153

### query

- compact: string; optional; allowed: true, false

## POST /api/creative-generator/video-editor/projects

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:158

### body

- fileName: string; required
- mimeType: string; required; allowed: video/mp4, video/quicktime, video/webm
- sizeBytes: integer; required

## DELETE /api/creative-generator/video-editor/projects/:id

Area: video-editor. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:238

### params

- id: string; required

## GET /api/creative-generator/video-editor/projects/:id

Area: video-editor. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:163

### params

- id: string; required

## PATCH /api/creative-generator/video-editor/projects/:id

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:168

### params

- id: string; required

### body

- words: array; optional
- captionGroups: array; optional
- suggestions: array; optional
- removeFillers: boolean; optional
- removeMistakes: boolean; optional
- removeDeadSpace: boolean; optional
- audioEnhancement: string; optional; allowed: off, clean, studio
- backgroundEnabled: boolean; optional
- backgroundPosition: object; optional
- backgroundMatchLighting: boolean; optional
- captionStyle: object; optional
- crop: object; optional
- brollEnabled: boolean; optional
- brollPlacements: array; optional

## GET /api/creative-generator/video-editor/projects/:id/asset-url

Area: video-editor. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:232

### params

- id: string; required

### query

- kind: string; required; allowed: source, output, background

## DELETE /api/creative-generator/video-editor/projects/:id/background

Area: video-editor. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:197

### params

- id: string; required

## POST /api/creative-generator/video-editor/projects/:id/background/upload-complete

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:191

### params

- id: string; required

### body

- width: integer; required
- height: integer; required

## POST /api/creative-generator/video-editor/projects/:id/background/upload-session

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:185

### params

- id: string; required

### body

- fileName: string; required
- mimeType: string; required; allowed: image/jpeg, image/png, image/webp
- sizeBytes: integer; required

## POST /api/creative-generator/video-editor/projects/:id/broll

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:212

### params

- id: string; required

## POST /api/creative-generator/video-editor/projects/:id/prepare

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:207

### params

- id: string; required

## GET /api/creative-generator/video-editor/projects/:id/renders

Area: video-editor. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:222

### params

- id: string; required

## POST /api/creative-generator/video-editor/projects/:id/renders

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:217

### params

- id: string; required

## POST /api/creative-generator/video-editor/projects/:id/renders/cancel

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:227

### params

- id: string; required

## POST /api/creative-generator/video-editor/projects/:id/transcribe

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:202

### params

- id: string; required

## POST /api/creative-generator/video-editor/projects/:id/upload-complete

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:179

### params

- id: string; required

### body

- durationMs: integer; required
- width: integer; required
- height: integer; required

## POST /api/creative-generator/video-editor/projects/:id/upload-session

Area: video-editor. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:174

### params

- id: string; required

## GET /api/creative-generator/videos/config

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:54

## GET /api/creative-generator/videos/estimate

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:58

### query

- renderMode: string; required; allowed: ugc_talking_head, cinematic_spokesperson, cinematic_brand_film

## GET /api/creative-generator/videos/projects

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:63

### query

- clientId: string; optional

## POST /api/creative-generator/videos/projects

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:69

### body

- clientId: string; required
- renderMode: string; required; allowed: ugc_talking_head, cinematic_spokesperson, cinematic_brand_film
- brollPolicy: string; required; allowed: automatic, client_media_only, ai_only, hybrid
- instructions: string; required
- finishedScript: string; optional
- reviewBeforeRendering: boolean; required
- maxAuthorizedCostCents: integer; required

## PATCH /api/creative-generator/videos/projects/:id

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:75

### params

- id: string; required

### body

- renderMode: string; optional; allowed: ugc_talking_head, cinematic_spokesperson, cinematic_brand_film
- brollPolicy: string; optional; allowed: automatic, client_media_only, ai_only, hybrid
- instructions: string; optional
- finishedScript: string; optional
- reviewBeforeRendering: boolean; optional
- maxAuthorizedCostCents: integer; optional

## PATCH /api/creative-generator/videos/providers/:providerId

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:88

### params

- providerId: string; required; allowed: runway, elevenlabs, heygen, luma, pexels

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## POST /api/creative-generator/videos/providers/:providerId/test

Area: creative-generator. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:100

### params

- providerId: string; required; allowed: runway, elevenlabs, heygen, luma, pexels

## GET /api/creative-generator/videos/runs

Area: creative-generator. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/creative-generator/videoRoutes.ts:82

### query

- clientId: string; optional

## GET /api/dashboard

Area: dashboard. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:46

### query

- viewRole: string; optional

## POST /api/dashboard/automation-tasks/:id/done

Area: dashboard. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:89

### params

- id: string; required

## POST /api/dashboard/client-updates/acknowledge

Area: dashboard. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:80

### body

- taskKey: string; required

## POST /api/dashboard/todos

Area: dashboard. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:51

### body

- text: string; required
- priority: string; optional; allowed: Low, Normal, High, Urgent
- dueDate: string; optional, nullable

## DELETE /api/dashboard/todos/:id

Area: dashboard. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:71

### params

- id: string; required

## PATCH /api/dashboard/todos/:id

Area: dashboard. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:60

### params

- id: string; required

### body

- text: string; optional
- completed: boolean; optional
- priority: string; optional; allowed: Low, Normal, High, Urgent
- dueDate: string; optional, nullable
- sortOrder: number; optional

## POST /api/dashboard/work-queue/complete

Area: dashboard. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/dashboard/routes.ts:100

### body

- clientId: string; required
- taskType: string; required

## GET /api/events

Area: events. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/events/routes.ts:21

## GET /api/landers

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:147

### query

- clientId: string; optional

## POST /api/landers

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:153

### body

- clientId: string; required
- campaignId: string; required, nullable
- name: string; required
- slug: string; optional

## GET /api/landers/:landerId

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:159

### params

- landerId: string; required

## PATCH /api/landers/:landerId

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:165

### params

- landerId: string; required

### body

- name: string; optional
- slug: string; optional
- status: string; optional; allowed: live, paused, archived
- delivery: object; optional
- tracking: object; optional

## GET /api/landers/:landerId/analytics

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:296

### params

- landerId: string; required

### query

- from: string; optional
- to: string; optional

## GET /api/landers/:landerId/assets

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:356

### params

- landerId: string; required

## POST /api/landers/:landerId/assets

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:332

### params

- landerId: string; required

### body

- fileName: string; required
- dataUrl: string; required
- role: string; optional; allowed: logo, favicon, avatar, poster, image, upload

## POST /api/landers/:landerId/chat

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:251

### params

- landerId: string; required

### body

- variantId: string; required
- text: string; optional
- attachmentAssetIds: array; optional

## GET /api/landers/:landerId/delivery

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:223

### params

- landerId: string; required

### query

- variantId: string; optional

## GET /api/landers/:landerId/domain-setup

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:127

### query

- clientId: string; required
- campaignId: string; required
- roots: string; optional

### params

- landerId: string; required

## POST /api/landers/:landerId/domain-setup

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:134

### body

- clientId: string; required
- campaignId: string; required
- landerId: string; required
- action: string; required; allowed: register, attach, verify
- root: string; required
- hostname: string; required
- quoteId: string; optional
- years: number; optional; allowed: 1
- autoRenew: boolean; optional; allowed: false
- maxChargeCents: number; optional; allowed: 300

### params

- landerId: string; required

## GET /api/landers/:landerId/messages

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:258

### params

- landerId: string; required

### query

- after: string; optional

## GET /api/landers/:landerId/research

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:233

### params

- landerId: string; required

## POST /api/landers/:landerId/research

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:240

### params

- landerId: string; required

### body

Schema not fully extracted. Inspect current source.

## GET /api/landers/:landerId/runs

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:272

### params

- landerId: string; required

## POST /api/landers/:landerId/runs/:runId/cancel

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:279

### params

- landerId: string; required
- runId: string; required

## GET /api/landers/:landerId/submissions

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:306

### params

- landerId: string; required

## POST /api/landers/:landerId/variants

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:197

### params

- landerId: string; required

### body

- fromVariantId: string; required
- name: string; optional

## DELETE /api/landers/:landerId/variants/:variantId

Area: landers. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:211

### params

- landerId: string; required
- variantId: string; required

## PATCH /api/landers/:landerId/variants/:variantId

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:204

### params

- landerId: string; required
- variantId: string; required

### body

- name: string; optional
- weight: number; optional

## POST /api/landers/:landerId/variants/:variantId/preview

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:217

### params

- landerId: string; required
- variantId: string; required

## POST /api/landers/:landerId/variants/:variantId/publish

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:184

### params

- landerId: string; required
- variantId: string; required

## POST /api/landers/:landerId/variants/:variantId/rollback

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:190

### params

- landerId: string; required
- variantId: string; required

### body

- versionId: string; required

## POST /api/landers/:landerId/variants/:variantId/versions

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:177

### params

- landerId: string; required
- variantId: string; required

### body

- content: unknown; required
- note: string; optional

## GET /api/landers/:landerId/versions/:versionId

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:171

### params

- landerId: string; required
- versionId: string; required

## GET /api/landers/assets/:file

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:344

### params

- file: string; required

## POST /api/lead-screening/status

Area: lead-screening. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/lead-screening/routes.ts:60

### body

Schema not fully extracted. Inspect current source.

## GET /api/onboarding/clients

Area: onboarding. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, partner, staff. Additional scope rules may apply.
Source: apps/api/src/onboarding/routes.ts:47

## PATCH /api/onboarding/clients/:id

Area: onboarding. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, partner, staff. Additional scope rules may apply.
Source: apps/api/src/onboarding/routes.ts:76

### params

- id: string; required

### body

- contractSigned: boolean; optional, nullable
- reviewCallDate: string; optional
- kickoffCallDate: string; optional
- onboardingCallDate: string; optional
- needsSetter: string; optional
- ghlAccount: string; optional
- a2pStatus: string; optional
- metaAccountName: string; optional
- adAccountLink: string; optional
- clientWebsite: string; optional
- meetingLocation: string; optional
- targetNiche: string; optional
- targetAudience: string; optional
- callTakers: string; optional
- dailyAdsBudget: number; optional, nullable
- servicesOffered: string; optional
- completedMeeting: string; optional
- slackChannelUrl: string; optional, nullable

## GET /api/onboarding/clients/:id/deal-close

Area: onboarding. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, partner, staff. Additional scope rules may apply.
Source: apps/api/src/onboarding/routes.ts:70

### params

- id: string; required

## GET /api/onboarding/payment-links

Area: onboarding. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, partner, staff. Additional scope rules may apply.
Source: apps/api/src/onboarding/routes.ts:56

## GET /api/onboarding/submissions

Area: onboarding. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, partner, staff. Additional scope rules may apply.
Source: apps/api/src/onboarding/routes.ts:66

## GET /api/payroll/ledger

Area: wise. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/wise/routes.ts:26

## GET /api/public/appointment-reports/:token

Area: appointment-reports. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/appointment-reports/routes.ts:40

### params

- token: string; required; sensitive, never log

## POST /api/public/appointment-reports/:token

Area: appointment-reports. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/appointment-reports/routes.ts:58

### params

- token: string; required; sensitive, never log

### body

- appointmentId: string; required
- status: string; required; allowed: no_show, unqualified
- recordingUrl: string; optional
- details: string; optional

## GET /api/public/client-videos/:token

Area: client-videos. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:235

### params

- token: string; required; sensitive, never log

## GET /api/public/client-videos/:token/analysis

Area: client-videos. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:262

### params

- token: string; required; sensitive, never log

## GET /api/public/client-videos/:token/media

Area: client-videos. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:251

### params

- token: string; required; sensitive, never log

## POST /api/public/client-videos/:token/reaction

Area: client-videos. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:273

### params

- token: string; required; sensitive, never log

### body

- reaction: string; required, nullable; allowed: heart, like, fire, clap, celebrate, eyes

## GET /api/public/landers/assets/:file

Area: landers. Read method; may have cache or collection side effects.
Access: Server bridge secret; not an agent bearer token. Additional scope rules may apply.
Source: apps/api/src/landers/publicRoutes.ts:44

### params

- file: string; required

## POST /api/public/landers/events

Area: landers. Mutation or action; explicit authority required.
Access: Server bridge secret; not an agent bearer token. Additional scope rules may apply.
Source: apps/api/src/landers/publicRoutes.ts:38

### body

Schema not fully extracted. Inspect current source.

## GET /api/public/landers/resolve

Area: landers. Read method; may have cache or collection side effects.
Access: Server bridge secret; not an agent bearer token. Additional scope rules may apply.
Source: apps/api/src/landers/publicRoutes.ts:23

### query

- site: string; required
- preview: string; optional

## POST /api/public/landers/submit

Area: landers. Mutation or action; explicit authority required.
Access: Server bridge secret; not an agent bearer token. Additional scope rules may apply.
Source: apps/api/src/landers/publicRoutes.ts:31

### body

Schema not fully extracted. Inspect current source.

## POST /api/public/sales-payments/:token/checkout

Area: sales. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:203

### params

- token: string; required; sensitive, never log

## GET /api/public/sops/:token

Area: sops. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:385

### params

- token: string; required; sensitive, never log

## GET /api/public/sops/:token/media/:mediaId

Area: sops. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:429

### params

- token: string; required; sensitive, never log
- mediaId: string; required

## GET /api/public/sops/:token/media/:mediaId/analysis

Area: sops. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:458

### params

- token: string; required; sensitive, never log
- mediaId: string; required

## POST /api/public/sops/:token/reaction

Area: sops. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:404

### params

- token: string; required; sensitive, never log

### body

- reaction: string; required, nullable; allowed: heart, like, fire, clap, celebrate, eyes

## POST /api/recorder/sessions

Area: recorder. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:84

### body

Schema not fully extracted. Inspect current source.

## POST /api/recorder/sessions/:id/cancel

Area: recorder. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:106

### params

- id: string; required

## POST /api/recorder/sessions/:id/consume

Area: recorder. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:100

### params

- id: string; required

## GET /api/recorder/sessions/:id/extension

Area: recorder. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:112

### params

- id: string; required

## POST /api/recorder/sessions/:id/extension-cancel

Area: recorder. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:135

### params

- id: string; required

## POST /api/recorder/sessions/:id/finalize

Area: recorder. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:129

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /api/recorder/sessions/:id/upload

Area: recorder. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:118

### params

- id: string; required

### body

- fileName: string; required
- mimeType: string; required; allowed: video/mp4, video/quicktime, video/webm
- sizeBytes: integer; required

## GET /api/recorder/sessions/pending

Area: recorder. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/recorder/routes.ts:94

### query

Schema not fully extracted. Inspect current source.

## GET /api/sales-library/coverage

Area: sales-library. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:64

### query

- cursor: string; optional

## PATCH /api/sales-library/exceptions

Area: sales-library. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:225

### body

- exceptions: array; required

## PATCH /api/sales-library/items/:id

Area: sales-library. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:206

### params

- id: string; required

### body

- hidden: boolean; optional
- reason: string; required
- allowOutlier: boolean; optional
- trackingIssue: string; optional, nullable

## POST /api/sales-library/items/:id/capture

Area: sales-library. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:175

### params

- id: string; required

### body

- image: string; required
- sourceUrl: string; required
- observed: object; required
- crop: object; optional

## GET /api/sales-library/items/:id/media

Area: sales-library. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:78

### params

- id: string; required

### query

- thumbnail: string; optional
- original: string; optional
- download: string; optional

## POST /api/sales-library/refresh

Area: sales-library. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:71

### body

Schema not fully extracted. Inspect current source.

## GET /api/sales-library/search

Area: sales-library. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:40

### query

- q: string; optional
- kind: string; optional; allowed: all, proof, creative, landing_page
- clientId: string; optional
- niche: string; optional
- period: string; optional; allowed: maximum, best_30d
- cursor: string; optional
- limit: integer; optional
- includeHidden: string; optional; allowed: 1, 0

## GET /api/sales-library/status

Area: sales-library. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales-library/routes.ts:60

## GET /api/sales/calls

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:141

### query

- refresh: string; optional; allowed: true, false

## GET /api/sales/calls/:callId

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:154

### params

- callId: string; required

## PATCH /api/sales/calls/:callId

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:176

### params

- callId: string; required

### body

- note: string; optional
- pifAmount: number; optional, nullable

## POST /api/sales/calls/:callId/review

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:165

### params

- callId: string; required

## POST /api/sales/deal-close

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:187

### body

- clientName: string; required
- ghlContactEmails: array; optional
- businessType: string; optional
- businessDescription: string; optional
- mainOffer: string; optional
- needsSetter: string; optional
- hasGhl: string; optional
- soldOffer: string; optional
- promisedResults: string; optional
- specialNotes: string; optional
- contractSigned: boolean; optional, nullable
- setupFee: number; optional, nullable
- setupFeeCollected: number; optional, nullable
- monthlyRetainer: number; optional, nullable
- onboardingCallDate: string; optional
- paymentPlanId: string; optional, nullable

## POST /api/sales/deal-close/prefill

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:129

### body

- emails: array; required

## GET /api/sales/deal-close/recent

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:118

## GET /api/sales/payments

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:109

### query

- filter: string; optional; allowed: outstanding, paid, overdue, voided, refunded, all

## GET /api/sales/payments/candidates

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:89

## GET /api/sales/payments/candidates/:dealCloseId/payer-email

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:98

### params

- dealCloseId: string; required

## POST /api/sales/payments/map-stripe

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:192

### body

- dealCloseId: string; required
- stripeChargeId: string; required
- reassign: boolean; optional

## POST /api/sales/payments/plans

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:120

### body

- dealCloseId: string; optional, nullable
- clientName: string; optional
- setupFeeCents: integer; optional
- payerEmail: string; required
- mode: string; required; allowed: deposit, balance, split
- payments: array; required

## POST /api/sales/payments/plans/:planId/requests

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:133

### params

- planId: string; required

### body

- kind: string; required; allowed: balance, installment
- amountCents: integer; required
- dueDate: string; optional, nullable

## POST /api/sales/payments/reconcile

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:182

## POST /api/sales/payments/requests/:requestId/replace

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:158

### body

- amountCents: integer; required
- dueDate: string; optional, nullable

### params

- requestId: string; required

## POST /api/sales/payments/requests/:requestId/retry-notification

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:173

### params

- requestId: string; required

## POST /api/sales/payments/requests/:requestId/void

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:146

### params

- requestId: string; required

## GET /api/sales/scorecard

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:207

### query

- from: string; optional
- to: string; optional
- closerId: string; optional
- calendar: variant/unknown; optional

## PATCH /api/sales/scorecard/calls/:callId

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:256

### params

- callId: string; required

### body

- outcome: string; optional; allowed: showed, no_show, rescheduled, cancelled, unknown
- qualified: boolean; optional, nullable
- offerMade: boolean; optional
- closed: boolean; optional
- cashCollected: number; optional, nullable
- revenue: number; optional, nullable
- closerTeamMemberId: string; optional, nullable
- recordingUrl: string; optional, nullable
- notes: string; optional, nullable
- reset: boolean; optional; allowed: true

## GET /api/sales/scorecard/export.csv

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:237

### query

- from: string; optional
- to: string; optional
- closerId: string; optional
- calendar: variant/unknown; optional

## POST /api/sales/scorecard/refresh

Area: sales. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:271

### body

Schema not fully extracted. Inspect current source.

## GET /api/sales/scorecard/view

Area: sales. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, partner, sales. Additional scope rules may apply.
Source: apps/api/src/sales/routes.ts:222

### query

- year: integer; required
- month: integer; optional
- day: string; optional
- closerId: string; optional
- calendar: variant/unknown; optional
- calendars: string; optional; allowed: all

## GET /api/setter-scripts

Area: setter-scripts. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: sales, setter. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:76

### query

- format: string; optional; allowed: index

## GET /api/setter-scripts/:clientId

Area: setter-scripts. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: sales, setter. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:111

### params

- clientId: string; required

## PATCH /api/setter-scripts/:clientId

Area: setter-scripts. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:141

### body

- revision: integer; required
- offers: array; optional
- aliases: array; optional
- callingHold: object; optional
- mappings: array; optional

### params

- clientId: string; required

## GET /api/setter-scripts/:clientId/creatives

Area: setter-scripts. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: sales, setter. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:127

### params

- clientId: string; required

## GET /api/setter-scripts/:clientId/history

Area: setter-scripts. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:312

### params

- clientId: string; required

## POST /api/setter-scripts/:clientId/refresh

Area: setter-scripts. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:257

### params

- clientId: string; required

## POST /api/setter-scripts/:clientId/restore

Area: setter-scripts. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:336

### body

- revision: integer; required
- revisionId: string; required

### params

- clientId: string; required

## POST /api/setter-scripts/:clientId/review

Area: setter-scripts. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:270

### body

- revision: integer; required
- action: string; required; allowed: approve, reject, resume_auto

### params

- clientId: string; required

## GET /api/setter-scripts/config

Area: setter-scripts. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: sales, setter. Additional scope rules may apply.
Source: apps/api/src/setter-scripts/routes.ts:62

## POST /api/setters/alerts/retry

Area: setters. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/setters/routes.ts:59

## GET /api/setters/alerts/status

Area: setters. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/setters/routes.ts:43

## GET /api/setters/board

Area: setters. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, sales, setter. Additional scope rules may apply.
Source: apps/api/src/setters/routes.ts:16

### query

Schema not fully extracted. Inspect current source.

## POST /api/setters/refresh

Area: setters. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/setters/routes.ts:33

### body

Schema not fully extracted. Inspect current source.

## GET /api/settings/agency

Area: settings. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:168

## PATCH /api/settings/agency

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:172

### body

- agencyName: string; optional
- logoUrl: string; optional
- themeColor: string; optional
- timezone: string; optional
- reportTimezone: string; optional
- debugModeEnabled: boolean; optional

## POST /api/settings/agency/logo

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:177

### body

- fileName: string; required
- dataUrl: string; required

## GET /api/settings/audit-log

Area: settings. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:226

### query

- clientId: string; optional
- source: string; optional; allowed: manual, webhook, import, stripe
- actorEmail: string; optional
- field: string; optional
- cursor: string; optional
- limit: integer; optional

## GET /api/settings/integrations

Area: settings. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:196

## GET /api/settings/integrations/anthropic

Area: landers. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:286

## PATCH /api/settings/integrations/anthropic

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:288

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## POST /api/settings/integrations/anthropic/recheck

Area: landers. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/landers/routes.ts:294

## PATCH /api/settings/integrations/assemblyai

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:408

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## POST /api/settings/integrations/assemblyai/recheck

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:415

## PATCH /api/settings/integrations/auphonic

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:421

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## POST /api/settings/integrations/auphonic/recheck

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:428

## PATCH /api/settings/integrations/discord

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:249

### body

- notificationsEnabled: boolean; optional
- callAlertsEnabled: boolean; optional
- taskAlertsEnabled: boolean; optional
- ticketAlertsEnabled: boolean; optional
- leadDeliveryAlertsEnabled: boolean; optional

## POST /api/settings/integrations/discord/provision

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:256

## POST /api/settings/integrations/discord/reconcile

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:261

## POST /api/settings/integrations/fathom/refresh

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:286

## PATCH /api/settings/integrations/ghl

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:305

### body

- locationId: string; optional
- privateKey: string; optional
- clearStoredCredentials: boolean; optional

## POST /api/settings/integrations/ghl/sync

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:319

## DELETE /api/settings/integrations/google-drive

Area: settings. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:376

## PATCH /api/settings/integrations/google-drive

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:359

### body

- activeParentFolderId: string; optional
- churnedParentFolderId: string; optional

## GET /api/settings/integrations/google-drive/callback

Area: settings. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:331

### query

- code: string; optional
- state: string; optional
- error: string; optional

## POST /api/settings/integrations/google-drive/connect

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:325

## POST /api/settings/integrations/google-drive/reconcile-churned

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:372

## POST /api/settings/integrations/google-drive/refresh

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:366

## GET /api/settings/integrations/google-places

Area: settings. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:200

## PATCH /api/settings/integrations/google-places

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:204

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## POST /api/settings/integrations/google-places/recheck

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:209

## GET /api/settings/integrations/health

Area: integration-health. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/integration-health/routes.ts:24

## POST /api/settings/integrations/health/check

Area: integration-health. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/integration-health/routes.ts:26

### body

Schema not fully extracted. Inspect current source.

## PATCH /api/settings/integrations/meta

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:265

### body

- userAccessToken: string; optional; sensitive, never log
- clearToken: boolean; optional; sensitive, never log

## GET /api/settings/integrations/meta-status

Area: settings. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:231

## POST /api/settings/integrations/meta/rotate

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:277

## PATCH /api/settings/integrations/namecheap

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:389

### body

- username: string; optional
- apiKey: string; optional; sensitive, never log
- environment: string; optional; allowed: sandbox, production
- clearStoredCredentials: boolean; optional

## PATCH /api/settings/integrations/openai

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:396

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## PATCH /api/settings/integrations/slack

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:235

### body

- enabled: boolean; optional
- botToken: string; optional; sensitive, never log
- clearBotToken: boolean; optional; sensitive, never log
- messageTemplates: object; optional

## POST /api/settings/integrations/slack/test-channel

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:447

### body

- clientId: string; optional
- channel: string; required

## GET /api/settings/integrations/sosfinder

Area: settings. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:213

## PATCH /api/settings/integrations/sosfinder

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:217

### body

- apiKey: string; optional; sensitive, never log
- clearApiKey: boolean; optional; sensitive, never log

## POST /api/settings/integrations/sosfinder/recheck

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:222

## PATCH /api/settings/integrations/stripe

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:434

### body

- secretKey: string; optional; sensitive, never log
- webhookSecret: string; optional; sensitive, never log
- clearStoredCredentials: boolean; optional

## POST /api/settings/integrations/stripe/recheck

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:441

## PATCH /api/settings/integrations/vercel

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:382

### body

- token: string; optional; sensitive, never log
- teamSlug: string; optional
- clearStoredCredentials: boolean; optional

## PATCH /api/settings/integrations/wise

Area: settings. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:292

### body

- apiToken: string; optional; sensitive, never log
- profileId: string; optional
- clearStoredCredentials: boolean; optional

## GET /api/sops

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:176

## POST /api/sops

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:240

### body

- categoryId: string; required
- title: string; required
- summary: string; optional
- body: object; optional

## DELETE /api/sops/:id

Area: sops. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:257

### params

- id: string; required

## PATCH /api/sops/:id

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:248

### params

- id: string; required

### body

- categoryId: string; optional
- title: string; optional
- summary: string; optional
- body: object; optional
- ownerTeamMemberId: string; optional, nullable
- reviewIntervalDays: integer; optional
- sortOrder: integer; optional

## POST /api/sops/:id/media/embeds

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:335

### params

- id: string; required

### body

- url: string; required

## POST /api/sops/:id/media/images

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:309

### body

- fileName: string; required
- dataUrl: string; required

### params

- id: string; required

## POST /api/sops/:id/media/videos

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:321

### body

- fileName: string; required
- mimeType: string; required
- sizeBytes: integer; required

### params

- id: string; required

## POST /api/sops/:id/reviewed

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:274

### params

- id: string; required

## GET /api/sops/:id/revisions

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:290

### params

- id: string; required

## GET /api/sops/:id/revisions/:version

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:294

### params

- id: string; required
- version: integer; required

## POST /api/sops/:id/revisions/:version/restore

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:299

### params

- id: string; required
- version: integer; required

## POST /api/sops/:id/share

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:282

### params

- id: string; required

### body

- enabled: boolean; required

## POST /api/sops/:id/status

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:265

### params

- id: string; required

### body

- status: string; required; allowed: draft, published

## GET /api/sops/:slug

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:371

### params

- slug: string; required

## GET /api/sops/categories

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:194

## POST /api/sops/categories

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:198

### body

- title: string; required
- description: string; optional
- icon: string; optional; allowed: book, rocket, handshake, clipboard, target, megaphone, trending-up, phone, heart, image, globe, wallet, users, settings, shield, sparkles
- color: string; optional; allowed: blue, purple, green, orange, yellow, red, tan, brown, mauve, gray
- audience: string; optional; allowed: internal, external
- sortOrder: integer; optional

## DELETE /api/sops/categories/:id

Area: sops. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:210

### params

- id: string; required

## PATCH /api/sops/categories/:id

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:202

### params

- id: string; required

### body

- title: string; optional
- description: string; optional
- icon: string; optional; allowed: book, rocket, handshake, clipboard, target, megaphone, trending-up, phone, heart, image, globe, wallet, users, settings, shield, sparkles
- color: string; optional; allowed: blue, purple, green, orange, yellow, red, tan, brown, mauve, gray
- audience: string; optional; allowed: internal, external
- sortOrder: integer; optional

## GET /api/sops/media/:mediaId

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:214

### params

- mediaId: string; required

## GET /api/sops/media/:mediaId/analysis

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:224

### params

- mediaId: string; required

## POST /api/sops/media/:mediaId/analysis

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:232

### params

- mediaId: string; required

## POST /api/sops/media/:mediaId/finalize

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:344

### params

- mediaId: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /api/sops/reorder

Area: sops. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:180

### body

Schema not fully extracted. Inspect current source.

## GET /api/sops/search

Area: sops. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:184

### query

- q: string; required
- audience: string; optional; allowed: internal, external

## GET /api/strategy

Area: strategy. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:82

### query

- status: string; optional; allowed: pending, in_review, approved
- clientId: string; optional
- niche: string; optional

## GET /api/strategy/:campaignId

Area: strategy. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:95

### params

- campaignId: string; required

## PATCH /api/strategy/:campaignId

Area: strategy. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:102

### params

- campaignId: string; required

### body

- note: string; optional
- icp: string; optional
- geo: string; optional
- services: string; optional
- landingPageNotes: string; optional
- targetNiche: string; optional
- startingDailyAdSpendUsd: number; optional, nullable
- sourceDocUrl: string; optional, nullable

## POST /api/strategy/:campaignId/angles

Area: strategy. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:116

### params

- campaignId: string; required

### body

Schema not fully extracted. Inspect current source.

## DELETE /api/strategy/:campaignId/angles/:angleId

Area: strategy. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:136

### params

- campaignId: string; required
- angleId: string; required

## PATCH /api/strategy/:campaignId/angles/:angleId

Area: strategy. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:123

### params

- campaignId: string; required
- angleId: string; required

### body

- nicheFamily: string; optional
- nicheDetail: string; optional
- family: string; optional
- headline: array; optional
- rationale: string; optional
- claimStatus: string; optional; allowed: verified, calculated, provisional, placeholder
- status: string; optional; allowed: proposed, approved
- creativeRecordIds: array; optional

## GET /api/strategy/:campaignId/angles/:angleId/creatives

Area: strategy. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:147

### params

- campaignId: string; required
- angleId: string; required

## POST /api/strategy/:campaignId/approve

Area: strategy. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:168

### params

- campaignId: string; required

## POST /api/strategy/:campaignId/stage

Area: strategy. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:180

### params

- campaignId: string; required

### body

- stage: string; required; allowed: Not started, In progress, Awaiting approval, Approved

## POST /api/strategy/:campaignId/submit

Area: strategy. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer. Additional scope rules may apply.
Source: apps/api/src/strategy/routes.ts:158

### params

- campaignId: string; required

## GET /api/team-members

Area: team. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:142

### query

- agencyId: string; optional

## POST /api/team-members

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:147

### body

- memberType: string; optional; allowed: human, ai
- agencyId: string; optional, nullable
- permissions: object; optional
- workspaceAdmin: boolean; optional
- name: string; required
- email: string; optional
- role: string; required; allowed: admin, sales, mediabuyer, csm, staff, setter, partner
- status: string; optional; allowed: active, offboarded
- title: string; optional, nullable
- description: string; optional, nullable
- avatarUrl: string; optional, nullable
- slackProfileUrl: string; optional, nullable
- slackMemberId: string; optional, nullable
- discordUserId: string; optional, nullable
- fathomApiKey: string; optional; sensitive, never log
- fathomWebhookSecret: string; optional; sensitive, never log
- monthlySalaryUsd: number; optional, nullable
- payrollStartDate: string; optional, nullable
- payrollFrequency: string; optional, nullable; allowed: weekly, biweekly, monthly
- agentPlatform: string; optional, nullable; allowed: openclaw, codex, claude, custom
- agentIcon: string; optional, nullable; allowed: bot, bot-message-square, cpu, brain-circuit, brain, terminal, code, workflow, globe, panels-top-left, layout-template, shield-check, file-check-2, clipboard-list, search, database, message-square, messages-square, mail, phone-call, headset, calendar-check, send, bell, megaphone, target, chart-line, trending-up, handshake, badge-dollar-sign, receipt, piggy-bank, pen-tool, palette, paintbrush, camera, video, clapperboard, image, mic, rocket, zap, flame, star, crown, trophy, gem, lightbulb, atom, orbit, satellite, telescope, compass, coffee, puzzle, gamepad-2, cat, dog, bird, rabbit, squirrel, turtle, fish, ghost
- agentIconColor: string; optional, nullable; allowed: brand, blue, teal, green, amber, orange, red, pink, violet, slate

## DELETE /api/team-members/:id

Area: team. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:253

### params

- id: string; required

### body

- confirmation: string; required; allowed: DELETE

## PATCH /api/team-members/:id

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:212

### params

- id: string; required

### body

- name: string; optional
- email: string; optional
- role: string; optional; allowed: admin, sales, mediabuyer, csm, staff, setter, partner
- status: string; optional; allowed: active, offboarded
- title: string; optional, nullable
- description: string; optional, nullable
- avatarUrl: string; optional, nullable
- slackProfileUrl: string; optional, nullable
- slackMemberId: string; optional, nullable
- discordUserId: string; optional, nullable
- fathomApiKey: string; optional; sensitive, never log
- fathomWebhookSecret: string; optional; sensitive, never log
- clearFathomApiKey: boolean; optional; sensitive, never log
- clearFathomWebhookSecret: boolean; optional; sensitive, never log
- monthlySalaryUsd: number; optional, nullable
- payrollStartDate: string; optional, nullable
- payrollFrequency: string; optional, nullable; allowed: weekly, biweekly, monthly
- agentPlatform: string; optional, nullable; allowed: openclaw, codex, claude, custom
- agentIcon: string; optional, nullable; allowed: bot, bot-message-square, cpu, brain-circuit, brain, terminal, code, workflow, globe, panels-top-left, layout-template, shield-check, file-check-2, clipboard-list, search, database, message-square, messages-square, mail, phone-call, headset, calendar-check, send, bell, megaphone, target, chart-line, trending-up, handshake, badge-dollar-sign, receipt, piggy-bank, pen-tool, palette, paintbrush, camera, video, clapperboard, image, mic, rocket, zap, flame, star, crown, trophy, gem, lightbulb, atom, orbit, satellite, telescope, compass, coffee, puzzle, gamepad-2, cat, dog, bird, rabbit, squirrel, turtle, fish, ghost
- agentIconColor: string; optional, nullable; allowed: brand, blue, teal, green, amber, orange, red, pink, violet, slate
- permissions: object; optional
- workspaceAdmin: boolean; optional

## DELETE /api/team-members/:id/agent-credentials

Area: team. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:192

### params

- id: string; required

## POST /api/team-members/:id/agent-credentials/rotate

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:185

### params

- id: string; required

## POST /api/team-members/:id/avatar

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:270

### params

- id: string; required

### body

- fileName: string; required
- dataUrl: string; required

## POST /api/team-members/:id/payments/mark-paid

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:296

### params

- id: string; required

### body

- dueDate: string; required

## POST /api/team-members/:id/send-invite

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:172

### params

- id: string; required

## POST /api/team-members/:id/send-password-reset

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:199

### params

- id: string; required

## PATCH /api/team-members/payments/:paymentId

Area: team. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:309

### params

- paymentId: string; required

### body

- status: string; required; allowed: paid, skipped, unpaid

## GET /api/team-members/payroll/upcoming

Area: team. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:292

## GET /api/tickets

Area: tickets. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:85

### query

- view: string; optional
- q: string; optional
- status: string; optional
- assigneeId: string; optional
- clientId: string; optional

## POST /api/tickets

Area: tickets. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:108

### body

- title: string; required
- status: string; optional; allowed: Backlog, In Progress, Waiting On Client, Awaiting Approval, Completed
- priority: string; optional; allowed: Low, Normal, High, Urgent
- description: string; optional
- bodyDoc: object; optional, nullable
- bodyText: string; optional
- clientScope: string; optional; allowed: none, all, clients
- clientIds: array; optional
- campaignIds: object; optional
- assigneeIds: array; optional
- dueDate: string; optional, nullable
- visibility: string; optional; allowed: internal, partner

## DELETE /api/tickets/:id

Area: tickets. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, csm. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:182

### params

- id: string; required

## GET /api/tickets/:id

Area: tickets. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:96

### params

- id: string; required

## PATCH /api/tickets/:id

Area: tickets. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:121

### params

- id: string; required

### body

- expectedRevision: integer; optional
- title: string; optional
- status: string; optional; allowed: Backlog, In Progress, Waiting On Client, Awaiting Approval, Completed
- priority: string; optional; allowed: Low, Normal, High, Urgent
- description: string; optional
- bodyDoc: object; optional, nullable
- bodyText: string; optional
- clientScope: string; optional; allowed: none, all, clients
- clientIds: array; optional
- campaignIds: object; optional
- assigneeIds: array; optional
- dueDate: string; optional, nullable
- visibility: string; optional; allowed: internal, partner

## POST /api/tickets/:id/attachments

Area: tickets. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:156

### params

- id: string; required

### body

- fileName: string; required
- dataUrl: string; required

## POST /api/tickets/:id/comments

Area: tickets. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:135

### params

- id: string; required

### body

- body: string; required
- visibility: string; optional; allowed: internal, partner

## POST /api/tickets/:id/read

Area: tickets. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:150

### params

- id: string; required

## GET /api/tickets/attachments/:id/image

Area: tickets. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:170

### params

- id: string; required

## GET /api/tickets/board

Area: tickets. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:79

### query

- view: string; optional
- q: string; optional
- status: string; optional; allowed: Backlog, In Progress, Waiting On Client, Awaiting Approval, Completed
- assigneeId: string; optional
- clientId: string; optional
- cursor: string; optional
- limit: integer; optional

## GET /api/tickets/options

Area: tickets. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, csm, mediabuyer, partner, sales, setter, staff. Additional scope rules may apply.
Source: apps/api/src/tickets/routes.ts:83

## GET /api/tools/business-lookup/config

Area: business-lookup. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, staff. Additional scope rules may apply.
Source: apps/api/src/business-lookup/routes.ts:21

## POST /api/tools/business-lookup/search

Area: business-lookup. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, staff. Additional scope rules may apply.
Source: apps/api/src/business-lookup/routes.ts:25

### body

Schema not fully extracted. Inspect current source.

## GET /api/voice-setter/calls

Area: voice-setter. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:28

## POST /api/voice-setter/calls

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:43

### body

Schema not fully extracted. Inspect current source.

## GET /api/voice-setter/calls/:id/artifacts/:name

Area: voice-setter. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:61

### params

- id: string; required
- name: string; required; allowed: audio.mp3, raw.json, transcript.txt

## POST /api/voice-setter/calls/:id/reconcile

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:48

### params

- id: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /api/voice-setter/calls/:id/reconcile-booking

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:57

### params

- id: string; required

### body

- appointmentId: string; required

## POST /api/voice-setter/calls/:id/sync

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:53

### params

- id: string; required

### body

- conversationId: string; required

## PUT /api/voice-setter/config

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:29

### body

- contactId: string; required
- calendarId: string; required
- ingressNumber: string; optional

## POST /api/voice-setter/disable

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:39

## POST /api/voice-setter/enable

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:38

## POST /api/voice-setter/provision

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:36

## POST /api/voice-setter/reset-suppression

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:40

### body

- confirmPersonalTestOnly: boolean; required; allowed: true

## GET /api/voice-setter/status

Area: voice-setter. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:27

## POST /api/voice-setter/twilio

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:30

### body

- accountSid: string; required
- authToken: string; required; sensitive, never log

## POST /api/voice-setter/verify

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:37

## POST /api/voice-setter/workflow-review

Area: voice-setter. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:35

### body

- evidence: string; required

## POST /api/webhooks/assemblyai/client-videos

Area: client-videos. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/client-videos/routes.ts:222

### body

- transcript_id: string; required
- status: string; optional

## POST /api/webhooks/assemblyai/sops

Area: sops. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sops/routes.ts:356

### body

- transcript_id: string; required
- status: string; optional

## POST /api/webhooks/assemblyai/video-editor

Area: video-editor. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/video-editor/routes.ts:243

### body

- transcript_id: string; required
- status: string; optional

## POST /api/webhooks/stripe

Area: sales. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:234

## POST /api/webhooks/stripe/agency/:agencyId

Area: sales. Mutation or action; explicit authority required.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/sales/paymentRoutes.ts:213

### params

- agencyId: string; required

## GET /api/website-manager

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:56

## GET /api/website-manager/builds/:buildId

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:117

### params

- buildId: string; required

## POST /api/website-manager/builds/:buildId/republish

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:123

### params

- buildId: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /api/website-manager/builds/:buildId/retry

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:138

### params

- buildId: string; required

### body

Schema not fully extracted. Inspect current source.

## GET /api/website-manager/builds/:buildId/screenshots/:index

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:151

### params

- buildId: string; required
- index: integer; required

## GET /api/website-manager/context

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:60

### query

- clientId: string; required
- campaignId: string; required

## GET /api/website-manager/drive-sources

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:66

### query

- clientId: string; required
- campaignId: string; required

## GET /api/website-manager/drive-sources/:fileId

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:72

### query

- clientId: string; required
- campaignId: string; required

### params

- fileId: string; required

## POST /api/website-manager/sites

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:79

### body

- clientId: string; required
- campaignId: string; required
- name: string; required
- selectedStrategyAngleIds: array; optional
- selectedDriveAssetIds: array; optional
- clientWebsite: string; optional
- comparisonWebsiteUrl: string; optional
- ghlSurveyId: string; optional, nullable
- ghlSurveyName: string; optional, nullable
- ghlSurveyUrl: string; optional
- ghlCalendarId: string; optional, nullable
- ghlCalendarName: string; optional, nullable
- ghlCalendarUrl: string; optional
- metaPixelId: string; optional
- supplementalInstructions: string; optional

## DELETE /api/website-manager/sites/:siteId

Area: website-manager. Destructive mutation.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:92

### params

- siteId: string; required

## PATCH /api/website-manager/sites/:siteId

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:85

### params

- siteId: string; required

### body

- name: string; optional
- selectedStrategyAngleIds: array; optional
- selectedDriveAssetIds: array; optional
- clientWebsite: string; optional
- comparisonWebsiteUrl: string; optional
- ghlSurveyId: string; optional, nullable
- ghlSurveyName: string; optional, nullable
- ghlSurveyUrl: string; optional
- ghlCalendarId: string; optional, nullable
- ghlCalendarName: string; optional, nullable
- ghlCalendarUrl: string; optional
- metaPixelId: string; optional
- supplementalInstructions: string; optional

## GET /api/website-manager/sites/:siteId/builds

Area: website-manager. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:111

### params

- siteId: string; required

## POST /api/website-manager/sites/:siteId/builds

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin, mediabuyer, staff. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:104

### params

- siteId: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /api/website-manager/sites/:siteId/domain

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:162

### params

- siteId: string; required

### body

- hostname: string; required

## POST /api/website-manager/sites/:siteId/domain/refresh

Area: website-manager. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/website-manager/routes.ts:169

### params

- siteId: string; required

## GET /api/wise/payments

Area: wise. Read method; may have cache or collection side effects.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/wise/routes.ts:34

## POST /api/wise/recipients/assign

Area: wise. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/wise/routes.ts:44

### body

- targetAccount: string; required
- teamMemberId: string; required, nullable

## POST /api/wise/sync

Area: wise. Mutation or action; explicit authority required.
Access: Role guard plus route-specific scope; roles: admin. Additional scope rules may apply.
Source: apps/api/src/wise/routes.ts:38

## GET /health

Area: health. Read method; may have cache or collection side effects.
Access: Public health check. Additional scope rules may apply.
Source: apps/api/src/health.ts:72

## GET /uploads/agency-logos/:file

Area: settings. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/settings/routes.ts:191

### params

- file: string; required

## GET /uploads/ai-agent-icons/:file

Area: ai-agent. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/ai-agent/routes.ts:113

### params

- file: string; required

## GET /uploads/team-avatars/:file

Area: team. Read method; may have cache or collection side effects.
Access: Route-specific checks; no role list extracted. Additional scope rules may apply.
Source: apps/api/src/team/routes.ts:287

### params

- file: string; required

## POST /webhooks/fathom/:teamMemberId

Area: fathom. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/fathom/routes.ts:22

### params

- teamMemberId: string; required

### body

Schema not fully extracted. Inspect current source.

## POST /webhooks/ghl/lead-screening

Area: lead-screening. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/lead-screening/routes.ts:48

### body

Schema not fully extracted. Inspect current source.

## POST /webhooks/ghl/notion-deal-close

Area: client-delivery. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/client-delivery/routes.ts:167

### body

Schema not fully extracted. Inspect current source.

## POST /webhooks/ghl/notion-onboarding

Area: client-delivery. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/client-delivery/routes.ts:152

### body

Schema not fully extracted. Inspect current source.

## POST /webhooks/voice-setter/elevenlabs

Area: voice-setter. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:104

### body

Schema not fully extracted. Inspect current source.

## POST /webhooks/voice-setter/tools/:name

Area: voice-setter. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:108

### body

Schema not fully extracted. Inspect current source.

### params

- name: string; required

## POST /webhooks/voice-setter/twilio/connect/:id

Area: voice-setter. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:87

### params

- id: string; required

## POST /webhooks/voice-setter/twilio/inbound

Area: voice-setter. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:82

## POST /webhooks/voice-setter/twilio/status

Area: voice-setter. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:96

## POST /webhooks/voice-setter/twilio/status/:id

Area: voice-setter. Mutation or action; explicit authority required.
Access: Provider webhook; not an agent command. Additional scope rules may apply.
Source: apps/api/src/voice-setter/routes.ts:92

### params

- id: string; required
