Update a System Prompt

Updates a system prompt. Fields that are not passed keep their original values, and at least one field is required. Passing the language renames the prompt, and passing the resource ID replaces the audio.

Request URL

PUT {base_url}/uc-cconfig/api/v1/sounds/system-prompts/{id}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code No String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the system prompt to update. You can obtain the ID using the Search System Prompts interface.
Body parameters
Parameter Required Type Description
language No String The language code of the system prompt. Passing this parameter renames the prompt, and the value supports letters, digits, and the symbols ( ) _: . - .
resourceId No String The ID of the language pack file resource. Passing this parameter replaces the audio.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<System_Prompt_Detail> The updated system prompt.
System_Prompt_Detail
Parameter Type Description
id String The ID of the voice package, which is referenced by business configurations.
ownershipLevel String

The ownership level of the voice package:

  • OWNERSHIP_LEVEL_SYSTEM: The voice package is a system-level package.
  • OWNERSHIP_LEVEL_PLATFORM: The voice package is a platform-level package.
language String The language code of the voice package.
isDefault Boolean

Whether the voice package is the fallback package. The fallback package cannot be deleted.

  • true
  • false
resourceId String The ID of the encrypted package resource, which is used for playback and download.
fileSize String The size of the encrypted package file, in bytes.
version String The semantic version number of the voice package.
canDelete Boolean

Whether the current user can delete the voice package. The value is true only for platform users whose owner matches.

  • true
  • false
createdAt String The time when the voice package was created, in Unix timestamp format (milliseconds).
updatedAt String The time when the voice package was last updated, in Unix timestamp format (milliseconds).
used Boolean

Whether the voice package is in use by the current tenant.

  • true
  • false
referencedTenantCodes Array<String> The list of tenant codes that reference the voice package. This parameter is returned only in the platform administrator view.
owner String The email address of the owner, with the primary user ID taking precedence over the user ID.
creator String The email address of the creator.