---
title: "Update a profile (partial)"
description: "Updates supplied mutable fields on a profile owned by the authenticated user. Omitted fields remain unchanged."
canonical: https://y2.dev/docs/api/reference/profiles/patchProfile/
---

Endpoint Reference[Profiles](https://y2.dev/docs/api/reference/profiles)

# Update a profile (partial)

Updates supplied mutable fields on a profile owned by the authenticated user. Omitted fields remain unchanged.

`PATCH https://api.y2.dev/api/v1/profiles/{profileId}`

- Operation ID: `patchProfile`
- Required scopes: `profiles:write`
- Contract: https://y2.dev/openapi.json

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `profileId` | path | string | Yes | Stable public profile ID. Legacy IDs remain accepted during the migration window. |
| `If-Match` | header | string | No | Strong ETag from the latest representation. A mismatch returns 412. |

## Request body

`application/json`: `ProfileUpdateRequest` (required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `topic` | string | No |  |
| `status` | `ProfileStatusEnum` | No | Profile status |
| `frequency` | `FrequencyEnum` | No | Report generation frequency |
| `scheduleTimeOfDay` | string | No |  |
| `scheduleDayOfWeek` | string | No | Weekday name (case-insensitive) or 0-6 (Sunday-Saturday) |
| `scheduleDayOfMonth` | string | No |  |
| `customPrompt` | string | No |  |
| `tags[]` | array of string | No |  |
| `isCommunity` | boolean | No |  |
| `blufStructure` | string | No |  |
| `searchConfig` | object | No |  |
| `searchConfig.searchDepth` | `basic`, `advanced` | No |  |
| `searchConfig.maxResults` | integer | No |  |
| `searchConfig.timeRange` | string | No |  |
| `searchConfig.topic` | string | No |  |
| `searchConfig.includeDomains[]` | array of string | No |  |
| `searchConfig.excludeDomains[]` | array of string | No |  |
| `modelConfig` | object | No |  |
| `modelConfig.modelId` | string | No |  |
| `modelConfig.temperature` | number | No |  |
| `modelConfig.maxOutputTokens` | integer | No |  |
| `budgetConfig` | object | No |  |
| `budgetConfig.maxCostPerReport` | number | No |  |
| `budgetConfig.alertThreshold` | number | No |  |
| `recursionConfig` | `RecursionConfigInput` | No |  |
| `recursionConfig.enabled` | boolean | Yes | When false, runs root-topic research without child subtopics. |
| `recursionConfig.maxDepth` | integer | Yes | Requested child-layer depth. The current runtime defaults an enabled value of `0` to `1` and caps values above `1` at one child layer. This field is ignored when `enabled` is false. |
| `recursionConfig.strategy` | `breadth-first`, `depth-first`, `hybrid` | Yes | Stored strategy preference. The current report engine executes its implemented breadth-first child-search path for every value. |
| `freshnessConfig` | object | No |  |
| `freshnessConfig.enabled` | boolean | No |  |
| `freshnessConfig.maxAgeMs` | integer | No |  |
| `freshnessConfig.preferRecentSources` | boolean | No |  |
| `freshnessConfig.recencyWeight` | number | No |  |
| `freshnessConfig.validateLinks` | boolean | No |  |
| `audioConfig` | object | No |  |
| `audioConfig.enabled` | boolean | No |  |
| `audioConfig.voiceId` | string | No |  |
| `audioConfig.speed` | number | No |  |
| `brandingTemplateId` | string | No | Branding template ID (paid workspace feature) |

## Responses

| Status | Description | Body |
| --- | --- | --- |
| 200 | Profile updated | `ProfileUpdateResponse` |
| 400 | Invalid request parameters |  |
| 401 | Missing or invalid API key |  |
| 403 | Insufficient permissions or access denied |  |
| 404 | Resource not found |  |
| 412 | The supplied If-Match validator does not match the current representation. |  |
| 429 | Rate limit exceeded (per-key or per-account aggregate) |  |
| 500 | Internal server error |  |

### 200 response fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | `PublicProfile` |  |
| `data.id` | string |  |
| `data.type` | string |  |
| `data.name` | string |  |
| `data.topic` | string |  |
| `data.status` | `ProfileStatusEnum` | Profile status |
| `data.frequency` | `FrequencyEnum` or null |  |
| `data.schedule` | object |  |
| `data.visibility` | object |  |
| `data.tags[]` | array of string |  |
| `data.customInstructions` | string or null |  |
| `data.reportStructure` | string or null |  |
| `data.configuration` | `PublicProfileConfiguration` |  |
| `data.lastDeliveredAt` | string or null (date-time) |  |
| `data.createdAt` | string (date-time) |  |
| `data.links` | object |  |
| `meta` | object |  |
| `meta.message` | string |  |
