API reference
Change a profile's name or description.
https://api.betterpost.dev/v1/profiles/{id}Only the fields you send change.
| Name | Description |
|---|---|
id | The profile id. |
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | 1 to 200 characters. |
description | string or null | No | Up to 1,000 characters; null clears it. |
curl -s -X PATCH https://api.betterpost.dev/v1/profiles/prof_1b7r4a9n2d5c8l0e3k6s9m2x \
-H "x-access-key: $BETTERPOST_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Acme Coffee Co.", "description": null }'200 OK
{
"success": true,
"profile": {
"id": "prof_1b7r4a9n2d5c8l0e3k6s9m2x",
"name": "Acme Coffee Co.",
"description": null,
"integrationCount": 2,
"createdAt": "2026-10-21T14:03:12.418Z",
"updatedAt": "2026-10-21T16:45:09.020Z"
}
}| Status | Code | When |
|---|---|---|
200 | The profile was updated. | |
400 | validation_error | A field is empty or too long. |
400 | invalid_json | The body is empty or not JSON. |
401 | unauthorized | Missing or unknown API key. |
404 | not_found | No such profile in this project. |
429 | rate_limited | More than 120 requests per minute. |