Skip to Content

POST /profile/update

Update Profile

Update profiles using composable infra architecture.

Request Body (UpdateProfileApiRequest)

FieldTypeRequiredDescription
profilesUpdateProfileItem[]NoList of profiles to update (required on first call when all is false)
allbooleanNoWhen true, apply patch to every profile matching the filter fields below (minus excluded_ids)
excluded_idsstring[]NoUUIDs to skip even when matched by all-mode filters
patchUpdateProfilePatchNoShared change set applied to every matched row when all=true (sparse — only set fields are updated; patch.profile_id ignored)
searchstringNoFull-text search query
cohort_idsstring[]NoFilter by cohort UUIDs
filter_department_idsstring[]NoFilter by department UUIDs
role_filterstringNoFilter by role name
cohort_searchstringNoSearch text for cohort facet (no-op for row filtering)
department_searchstringNoSearch text for department facet (no-op for row filtering)
role_searchstringNoSearch text for role facet (no-op for row filtering)
flag_searchstringNoSearch text for flag facet (no-op for row filtering)
idempotency_keystringNoOperation key for ack — promotes or rejects a dormant update
softbooleanNoStage the update dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (promote) or reject dormant state. Only meaningful with idempotency_key

Response (UpdateProfileApiResponse)

FieldTypeRequiredDescription
resultsProfileResultItem[]YesPer-item update results
idempotency_keystringNoIdempotency key echoed back for client correlation
profilesListProfilesApiProfile[]NoHydrated rows for the successfully-updated profiles (mirrors /profile/search shape)
Last updated on