Profiles
Update
Update a profile's name, description, or color.
Endpoint
PATCH https://api.postpeer.dev/v1/profiles/{id}Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Profile ID |
Body Parameters
All fields are optional — pass only the ones you want to change.
| Parameter | Type | Description |
|---|---|---|
name | string | New name (1–200 chars). |
description | string | null | New description (max 1000 chars). Pass null to clear. |
Example
curl -X PATCH "https://api.postpeer.dev/v1/profiles/65ab123" \
-H "x-access-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Acme Inc", "description": "Updated copy" }'import PostPeer from '@postpeer/node';
const client = new PostPeer();
const { data } = await client.profiles.update({
path: { id: '65ab123' },
body: { name: 'Acme Inc', description: 'Updated copy' },
});from postpeer import PostPeer
with PostPeer() as client:
profile = client.profiles.update(
id="65ab123",
name="Acme Inc",
description="Updated copy",
)Response
{
"success": true,
"profile": {
"id": "65ab...",
"name": "Acme Inc",
"description": "Updated copy",
"integrationCount": 3,
"createdAt": "2026-05-03T08:33:36.445Z",
"updatedAt": "2026-05-03T09:01:11.000Z"
}
}Status Codes
| Code | Meaning |
|---|---|
200 | Profile updated |
400 | Invalid profile id or invalid body |
404 | Profile not found |