API reference
Create a named group for connected accounts.
https://api.betterpost.dev/v1/profilesSee the profiles guide for when to use profiles.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | 1 to 200 characters. |
description | string | No | Up to 1,000 characters. |
curl -s -X POST https://api.betterpost.dev/v1/profiles \
-H "x-access-key: $BETTERPOST_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Acme Coffee", "description": "Brand accounts for Acme" }'201 Created
{
"success": true,
"profile": {
"id": "prof_1b7r4a9n2d5c8l0e3k6s9m2x",
"name": "Acme Coffee",
"description": "Brand accounts for Acme",
"integrationCount": 0,
"createdAt": "2026-10-21T14:03:12.418Z",
"updatedAt": "2026-10-21T14:03:12.418Z"
}
}| Status | Code | When |
|---|---|---|
201 | The profile was created. | |
400 | validation_error | name is missing or empty, or a field is too long. |
400 | invalid_json | The body is empty or not JSON. |
401 | unauthorized | Missing or unknown API key. |
429 | rate_limited | More than 120 requests per minute. |