Update Brand Voice
POST
https://api.konpro.ai/v1/brand_voice/{brand_voice_id}Modify an existing brand voice by its unique identifier. Include only the fields you wish to change in the request body.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
cURL Request
shell
curl --request POST \
--url https://api.konpro.ai/v1/brand_voice/<brand_voice_id> \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
"name": "Updated Brand Voice",
"blacklist": ["HeyGen", "John Smith"],
"whitelist": [["AI", "artificial intelligence"]],
"tones": ["professional", "friendly"],
"vocabulary": [["HeyGen", "Hey-jen"]],
"tone": "Communicate with clarity and enthusiasm."
}'Path Parameter
| Parameter | Type | Description |
|---|---|---|
| brand_voice_id | string | Unique ID of the brand voice to update (required) |
Request Body Parameters
| Field | Type | Description |
|---|---|---|
| name | string | New name for the brand voice |
| blacklist | array[string] | List of words to exclude from translation (e.g., brand or personal names) |
| whitelist | array[tuple[string, string]] | Pairs of words with forced translations |
| tones | array[string] | Tone keywords to influence the voice style |
| vocabulary | array[tuple[string, string]] | Word pairs providing pronunciation guidance |
| tone | string | Overall tone description for the brand voice |
Response
Response Structure
Returns the updated brand voice object with all current field values.
Sample Response
json
{
"id": "voice_123",
"name": "Updated Brand Voice",
"blacklist": ["HeyGen", "John Smith"],
"whitelist": [["AI", "artificial intelligence"]],
"tones": ["professional", "friendly"],
"vocabulary": [["HeyGen", "Hey-jen"]],
"tone": "Communicate with clarity and enthusiasm.",
"updated_at": "2024-01-15T13:30:00Z"
}Notes
- Requires API authentication.
- Include only the fields you wish to update in the request body.
- All fields in the request body are optional.
- Blacklist words are excluded from translation.
- Whitelist provides forced word translations.
- Vocabulary pairs help with pronunciation guidance.
- Tones influence the overall voice style and delivery.
- Refer to Error Responses for error information.
Example Usage
Shell
curl --request POST \
--url https://api.konpro.ai/v1/brand_voice/<brand_voice_id> \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
"name": "Updated Brand Voice",
"blacklist": ["HeyGen", "John Smith"],
"whitelist": [["AI", "artificial intelligence"]],
"tones": ["professional", "friendly"],
"vocabulary": [["HeyGen", "Hey-jen"]],
"tone": "Communicate with clarity and enthusiasm."
}'LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Success
400 - Bad Request
LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Success
400 - Bad Request