Skip to main content
PATCH
Update a persona

Authorizations

Authorization
string
header
required

An Egma API key.

Path Parameters

personaId
string
required
Minimum string length: 1

Body

application/json
projectId
string
Minimum string length: 1
name
string

Your team's label in the persona library. The caller does not speak this label.

description
string | null
identityName
string

The human name the caller gives the agent, separate from the library name.

personality
string

How the caller behaves and speaks. Put the situation and goal in the test scenario.

language
string

The caller's language, such as en-US.

models
object

The complete language, speech recognition, and speech synthesis selections. Read /v1/persona-form for available choices and recommendations.

expectedVersionId
string

The current versionId from Get a persona. Required when editing identityName, personality, or language. A stale value returns 409 version_conflict.

Minimum string length: 1

Response

The updated persona.

id
string
required
Minimum string length: 1
projectId
string | null
required
Minimum string length: 1
name
string
required
description
string | null
required
version
integer
required
Required range: x >= 1
versionId
string
required
Minimum string length: 1
identityName
string
required

The human name the caller gives the agent, separate from the library name.

personality
string
required

How the caller behaves and speaks. Put the situation and goal in the test scenario.

language
string
required

The caller's language, such as en-US.

parameterContract
object[]
required
settings
object | null
required

This project's saved model and voice settings. Null before first use. Settings changes do not create a behavior version.

owner
enum<string>
required
Available options:
egma,
organization
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required