Profiles
Create a profile
Creates a profile for one of your customers. Requires an account-wide key; profile-scoped keys cannot create profiles.
Required permission: `connections:write`
POST
/v1/profilesconnections:writeRequest
Authorization
Send your API key as a Bearer token in the Authorization header.
Headers
Idempotency-KeystringoptionalA unique key so a retried request is not applied twice. Stored for 24 hours.
Request body
namestringrequiredDisplay name, usually your customer’s name.
descriptionstringoptionalFree-form note about this customer.
Response
Returns 201.
Profilerequired
Errors
Failures use the standard error format.
| Status | Code | When it happens |
|---|---|---|
| 400 | invalid_request | The request body or query string failed validation. The message names the offending field. |
| 401 | invalid_api_key | The key does not exist, was revoked, or is malformed. Keys start with cdyn_live_. |
| 403 | insufficient_permission | The key is missing the scope this endpoint needs, for example posts:write on a readonly key. |
| 403 | plan_limit | A plan quota was exhausted. The response carries entitlement, usage, and limit so you can surface the reason. |
| 429 | rate_limit_exceeded | Too many requests for this key. Honour the Retry-After header before retrying. |
| 500 | internal_error | Something failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists. |