---
title: "Edit profile description"
method: POST
path: "/profiles/{profileId}/description"
tags: ["profiles"]
---

# Edit profile description

`POST /profiles/{profileId}/description`

## Request

- Base URL: `https://api.usecrouton.com`
- URL: `https://api.usecrouton.com/profiles/{profileId}/description`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/usecrouton/apis/crouton-api/docs/profiles/:profileId/description/post.ts> (a function with typed inputs; its response is checked against the schema)

Sets the markdown description for a profile (request `description` is raw markdown). The response returns sanitized HTML in `description` and the stored markdown in `descriptionRaw`. Pass `null` or an empty string to clear (`hasDescription` is then false). The API key must be associated with a user who is editing their own profile, or a team administrator editing any profile in the organization.

## Request body

- object
  - `description` string, nullable, required

## Response `200`

The updated profile description.

## Other responses

- `400`: 400
- `401`: Missing, invalid, revoked, or expired API key.
- `403`: API key lacks the required resource or access level.
- `404`: Profile not found
- `422`: 422

## Changes

- **2026-10-28** `809cbf38e25a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usecrouton/apis/crouton-api/changes/profiles/:profileId/description/post.md)

---

[API](https://skmtc.dev/usecrouton/apis/crouton-api.md) - [All operations](https://skmtc.dev/usecrouton/apis/crouton-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usecrouton/apis/crouton-api/revisions/809cbf38e25a?raw)