Simulation Persona

Update a persona

Updates an existing persona by its ID.

put/v1/persona/{personaId}

Path parameters

personaIdstring required

The ID of the persona to update

Request body

namestring

The name the agent will identify as during conversations

descriptionstring nullable

Human-readable description of the persona

language'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE'

Primary language ISO 639-1 code for the persona

secondaryLanguage'EN' nullable

Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)

understoodLanguagesstring[]

Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support.

accent'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL'

Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants

age'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY'

How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports.

gender'MALE' | 'FEMALE'

Gender of the persona

Background noise setting

speechPace'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST'

Speech pace of the persona

speechClarity'CLEAR' | 'VAGUE' | 'RAMBLING'

Speech clarity of the persona

hasDisfluenciesboolean

Whether the persona uses filler words like "um" and "uh"

Base emotional state of the persona

intentClarity'CLEAR' | 'INDIRECT' | 'VAGUE'

How clearly the persona expresses their intentions

confirmationStyle'EXPLICIT' | 'VAGUE'

How the persona confirms information

memoryReliability'HIGH' | 'LOW'

How reliable the persona's memory is

responseTiming'RELAXED' | 'NORMAL' | 'QUICK'

Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED)

backstoryPromptstring nullable

Background story and behavioral patterns for the persona

idleMessagesstring[] nullable

Messages the persona will say when the agent goes silent during a call. null = "Automatic": language-appropriate defaults are used at call time.

idleTimeoutSecondsinteger

Seconds of silence before the persona sends an idle message

idleMessageMaxSpokenCountinteger

Maximum number of idle messages the persona will send before giving up

idleMessageResetCountOnUserSpeechEnabledboolean

Whether the idle message counter resets when the agent speaks

propertiesobject

Additional custom properties about the persona

Example request

{
  "backstoryPrompt": "A busy professional calling during lunch break",
  "properties": {
    "age": 35,
    "zipCode": "94105",
    "occupation": "Software Engineer"
  }
}

Response

The updated persona

Example response

{
  "data": {
    "backstoryPrompt": "A busy professional calling during lunch break",
    "properties": {
      "age": 35,
      "zipCode": "94105",
      "occupation": "Software Engineer"
    }
  }
}

Changes

Changed in 2 of the 109 revisions of this API.11013

Aug 26, 2026b4a59c7057ca2See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the required property / to the response with the status
  response-required-property-added
Aug 17, 2026887b091b3d8111011See the full diff
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ●
  added the new HE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new IL enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property default value changed from 5 to 3
  request-property-default-value-changed
- ○
  the request property default value changed from false to true
  request-property-default-value-changed
- ○
  the request property default value Are you still there? Hello? Can you hear me? was removed
  request-property-default-value-removed
- ○
  added the new HE enum value to the request property
  request-property-enum-value-added
- ○
  added the new IL enum value to the request property
  request-property-enum-value-added
- ○
  the response's property default value changed from 5 to 3 for the status
  response-property-default-value-changed
- ○
  the response's property default value changed from false to true for the status
  response-property-default-value-changed
- ○
  the response's property default value Are you still there? Hello? Can you hear me? was removed for the status
  response-property-default-value-removed
- ○
  added the required property / to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history