Skip to Content

POST /persona/draft

Patch Persona Draft

Patch persona draft — composable infra architecture.

Request Body (PatchPersonaDraftApiRequest)

FieldTypeRequiredDescription
draft_idstringNoExisting draft UUID to patch (omit to create a new draft)
namestringNoDisplay name text (creates new name resource)
name_idstringNoUUID of an existing name resource to select
descriptionstringNoDescription text (creates new description resource)
description_idstringNoUUID of an existing description resource to select
colorstringNoHex color code (creates new resource if color_id not provided)
color_idstringNoUUID of a color resource to select
iconstringNoResolved SVG markup for the icon (hydrated from icons_resource)
icon_idstringNoUUID of an icon resource to select
instructionsstringNoInstruction template text (creates new instruction resource)
instructions_idstringNoUUID of an existing instruction resource to select
flag_idsstring[]NoSelected flag option UUIDs — canonical; server derives semantics by flag type/value
activebooleanNoDenormalized persona_active flag state; resolved to a flag_ids entry server-side
examplesstring[]NoExample texts (creates new example resources)
example_idsstring[]NoExisting example resource UUIDs to select
department_idsstring[]NoDepartment UUIDs to associate
departmentsstring[]NoDepartment names (resolved to UUIDs server-side)
parameter_field_idsstring[]NoParameter field UUIDs to associate
parameter_fieldsstring[]NoParameter field names (resolved to UUIDs server-side)
voice_idsstring[]NoVoice resource UUIDs to associate
voicesstring[]NoVoice values (resolved to UUIDs server-side)
pending_idsstring[]NoResource IDs to keep as pending (active=false on connection)
idempotency_keystringNoOperation key for ack — promotes or rejects a dormant draft
softbooleanNoStage the draft dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (promote) or reject dormant state. Only meaningful with idempotency_key

Response (PatchPersonaDraftApiResponse)

FieldTypeRequiredDescription
successbooleanYesWhether the draft operation succeeded
draft_idstringYesUUID of the created or updated draft
idempotency_keystringYesIdempotency key for this draft operation (same as draft entry ID)
messagestringYesHuman-readable result message
form_stateapp__infra__persona__types__DraftFormStateYesComplete form state after patch — client should replace local state
Last updated on