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

profiles.trash

Move up to 1,000 profiles to trash; per-profile results.

Capability: profile.trashCommand (idempotent)DestructiveMCP tool: profiles_trash
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.
idsbodyarray<string (uuid)>Yes(min 1 items, max 1000 items)

Examples

curl -X POST "https://browlix.com/api/public/v1/profiles/trash" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","ids":["<id>"]}'

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.opstringYes
data.totalintegerYes(min -9007199254740991, max 9007199254740991)
data.succeededintegerYes(min -9007199254740991, max 9007199254740991)
data.failedintegerYes(min -9007199254740991, max 9007199254740991)
data.failuresarray<object>YesOne entry per item that was refused, with its typed reason
data.failures[].idstringNo
data.failures[].codestringNo
data.created_idsarray<string (uuid)>Yes
data.selection_idstring (uuid)YesThe frozen set this bulk command applied to (replays reuse it)
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