Documentation menu

Update profile

Replace a profile's name, externalId, and metadata.

PUThttps://app.tryadeli.com/api/v1/profiles/{profileId}

AuthorizationBearer <API key>How keys work

Request

curl --fail-with-body -X PUT "https://app.tryadeli.com/api/v1/profiles/00000000-0000-4000-8000-000000000002" \
  -H "Authorization: Bearer $ADELI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Client A",
  "externalId": "customer-123",
  "metadata": {
    "plan": "pro"
  }
}'

Response

{
  "id": "00000000-0000-4000-8000-000000000002",
  "name": "Client A",
  "externalId": "customer-123",
  "metadata": { "plan": "pro" },
  "isDefault": false,
  "createdAt": "2026-09-09T14:30:00.000Z",
  "updatedAt": "2026-10-09T16:00:00.000Z"
}

Replaces the mutable fields. This is a full replace, not a merge: omitting externalId or metadata clears them.

Path parameters

profileIduuidRequired: A profile in your organization. Any other value returns 404 profile_not_found.

Body

namestringRequired: 1–200 characters after trimming. Must be unique across your organization's profiles.
externalIdstring | null: Up to 200 characters. Must be unique across your organization's profiles when not null.
metadataobject | null: Any JSON object, up to 16 KiB encoded as UTF-8. Arrays and scalars are rejected.

Both conflict responses carry the colliding profile in details.existingProfileId, as they do on create.

Errors — 401 unauthorized, 400 invalid_request, 400 invalid_profile, 404 profile_not_found, 409 profile_name_conflict, 409 profile_external_id_conflict, 502 database_error.