Skip to Content

POST /profile/draft

Patch Profile Draft

Patch profile draft — composable infra architecture.

Request Body (PatchProfileDraftApiRequest)

FieldTypeRequiredDescription
draft_idstringNoExisting draft UUID to update
input_draft_idstringNoExisting draft UUID to update
namestringNoName value to resolve or create
name_idstringNoUUID of the name resource
emailstringNoEmail value to resolve or create
emailsstring[]NoEmail values to resolve or create
flag_idsstring[]NoSelected flag option UUIDs — canonical
activebooleanNoDenormalized profile_active flag state; resolved to a flag_ids entry server-side
department_idsstring[]NoDepartment UUIDs to assign
departmentsstring[]NoDepartment names to resolve
email_idsstring[]NoEmail resource UUIDs
rolestringNoRole name to resolve (single-name shortcut; legacy)
role_idstringNoRole resource UUID
role_draftProfileRoleDraftValueNoInline-creatable role; id=null asks server to create with permissions/limits
primary_department_idstringNoUUID of the department to designate as primary
pending_idsstring[]NoResources to keep dormant
idempotency_keystringNoIdempotency key for draft writes
softbooleanNoStage the draft dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoWhether to accept the pending draft state

Response (PatchProfileDraftApiResponse)

FieldTypeRequiredDescription
successbooleanYesWhether the draft save succeeded
draft_idstringYesUUID of the saved draft
idempotency_keystringNoIdempotency key for draft writes
messagestringYesResult message
form_stateapp__infra__profile__types__DraftFormStateNoServer-authoritative form state
Last updated on