Profiles
Create
Create a profile to group one or more social integrations.
Endpoint
POST https://api.postpeer.dev/v1/profilesBody Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Profile name (1–200 chars). Doesn't need to be unique. |
description | string | No | Free-form description (max 1000 chars). |
Example
curl -X POST https://api.postpeer.dev/v1/profiles \
-H "x-access-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Co",
"description": "Marketing accounts"
}'Response
{
"success": true,
"profile": {
"id": "65ab...",
"name": "Acme Co",
"description": "Marketing accounts",
"integrationCount": 0,
"createdAt": "2026-05-03T08:33:36.445Z",
"updatedAt": "2026-05-03T08:33:36.445Z"
}
}Save profile.id. Pass it as ?profileId= when calling /v1/connect/:platform to bind the resulting integration to this profile.
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Profile ID — use as profileId on connect URLs |
name | string | The name you provided |
description | string | null | The description you provided |
integrationCount | integer | Number of active integrations bound to this profile (always 0 immediately after create) |
createdAt | string | ISO 8601 timestamp |
updatedAt | string | ISO 8601 timestamp |
Status Codes
| Code | Meaning |
|---|---|
201 | Profile created |
400 | Validation error (missing name, exceeded length, etc.) |