API reference

Profiles

Update a profile

Renames a profile or changes its description.

Required permission: `connections:write`

PATCH/v1/profiles/{id}connections:write

Request

Authorization

Send your API key as a Bearer token in the Authorization header.

Path parameters

idstringrequired

Profile id.

Request body

namestringoptional
descriptionstringnullableoptional

Response

Returns 200.

Profilerequired

Errors

Failures use the standard error format.

StatusCodeWhen it happens
400invalid_requestThe request body or query string failed validation. The message names the offending field.
401invalid_api_keyThe key does not exist, was revoked, or is malformed. Keys start with cdyn_live_.
403profile_not_accessibleThe requested profile is outside this key’s scope, or belongs to another account.
404not_foundThe resource does not exist inside the resolved profile.
429rate_limit_exceededToo many requests for this key. Honour the Retry-After header before retrying.
500internal_errorSomething failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists.