Skip to main content
POST/api/public/v1/preference-templates

preference_templates.create

Create a template (revision 1); values default to the canonical preference defaults.

Capability: workspace.updateCommand (idempotent)MCP tool: preference_templates_create
View as Markdown

Parameters

NameTypeRequiredDescription
command_idbodystring (uuid)YesClient-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT.
namebodystringYes(min length 1, max length 80)
valuesbodyobjectNoBrowserPreferences; omitted = canonical defaults
is_defaultbodybooleanNoDefault: `false`.
notebodystringNo(max length 300) Default: `""`.

Examples

curl -X POST "https://browlix.com/api/public/v1/preference-templates" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","name":"<name>"}'

Response

201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.

The field list of this reply is not published yet; read data as JSON.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
CONFLICT409No
OUTCOME_UNKNOWN202Yes
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations