---
title: "Update a profile"
method: PUT
path: "/v1/profiles/{profileId}"
tags: ["Profiles"]
---

# Update a profile

`PUT /v1/profiles/{profileId}`

## Request

- Base URL: `https://api.postzen.dev`
- URL: `https://api.postzen.dev/v1/profiles/{profileId}`
- Auth: HTTP bearer

Updates one or more profile fields. This endpoint requires a read-write API key.

## Request body

- ProfileUpdateRequest: Include at least one field.
  - `name` string
  - `description` string, nullable: Pass an empty string or `null` to clear the description.
  - `color` string
  - `isDefault` boolean: Set to `true` to make this the default profile.

## Response `200`

Profile updated.

- ProfileWriteResponse
  - `message` string, required
  - `profile` Profile, required
    - `_id` string, required: PostZen profile id.
    - `userId` string, required: Owner user id.
    - `name` string, required
    - `description` string
    - `color` string, required: Hex color in `#rrggbb` format.
    - `isDefault` boolean, required
    - `createdAt` string, date-time, required

## Other responses

- `400`: Invalid request.
- `401`: Missing or invalid API key.
- `403`: The API key does not have sufficient permission or profile access.
- `404`: Resource not found.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/postzen/apis/postzen-public-api.md) · [All operations](https://skmtc.dev/postzen/apis/postzen-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/postzen/apis/postzen-public-api/revisions/40863e3710ec?raw)