Skip to main content
POST/api/public/v1/profiles

profiles.create

Create a profile from defaults plus the given fields (ProfileConfig contract).

Capability: profile.createCommand (idempotent)MCP tool: profiles_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.
profilebodyobjectYesProfileConfig fields to set over the workspace defaults (name, config, proxy_id, group_id, tag_ids, notes …)

Examples

curl -X POST "https://browlix.com/api/public/v1/profiles" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","profile":{"name":"Shop 01","config":{"os":"windows"}}}'

Response

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

FieldTypeAlways presentDescription
dataobjectYes
data.profile_idstring (uuid)Yes
data.numberintegerYes(min -9007199254740991, max 9007199254740991)
data.revisionintegerYes(min -9007199254740991, max 9007199254740991)
data.changedarray<string>YesFields that changed; empty when the edit was a no-op (revision kept)
correlation_idstring (uuid)Yes
replayedbooleanNotrue when this command_id was already applied and the stored receipt came back

New fields can appear at any time; ignore the ones you do not know.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
CONFLICT409No
OUTCOME_UNKNOWN202Yes
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations