Skip to main content
PATCH
Update Voice

Authorizations

X-API-Key
string
header
required

API Key for authentication

Path Parameters

id
string
required

Body

application/json
id
string<uuid>
required

ID of the Voice to update.

name
string

New Voice name. Omit to keep the current one.

Minimum string length: 1
backgroundAboutUser
string

Free-form plain text about the user themselves — role, background, perspective. Used as background when generating comments and direct messages, and when analyzing incoming posts. Omit to keep the current value; pass an empty string to clear it.

backgroundAboutCompany
string

Free-form plain text about the user's company, product, market, and target audience. Used as background when generating comments and direct messages, and when analyzing incoming posts. Omit to keep the current value; pass an empty string to clear it.

instructionsForComments
string

Free-form plain text with tone instructions for comment generation (tone, structure, do/don't). Used only when generating comments, not direct messages. Omit to keep the current value; pass an empty string to clear it.

instructionsForDm
string

Free-form plain text with tone instructions for direct-message generation (tone, structure, do/don't). Used only when generating direct messages, not comments. Omit to keep the current value; pass an empty string to clear it.

isLearningModeEnabled
boolean

Whether the Voice is in learning mode. When true, the backend auto-saves as Comment Examples only those comments the user both approved AND edited before approval (unchanged auto-approved comments are NOT saved). Only comments are learned — direct messages are never auto-saved. The Voice's Comment Examples are capped at 20 entries; auto-saved and manual entries share the same 20-slot cap. When false, no auto-learning happens and existing Comment Examples keep being used as-is. Omit to keep the current value.

Response

status
enum<string>
required

Response status

Available options:
success
data
object | null
required

No response payload

Example:

null

message
string
required

Success message

Example:

"Operation completed successfully"