/api/public/v1/bookmarks/applications/{id}/cancelbookmarks.cancel
Withdraw a queued application before a browser takes it; CONFLICT while the browser is applying it or once it ended.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
idpath | string (uuid) | Yes | Bookmark application id |
command_idbody | string (uuid) | Yes | Client-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. |
Examples
curl -X POST "https://browlix.com/api/public/v1/bookmarks/applications/<id>/cancel" \
-H "Authorization: Bearer $BROWLIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"command_id":"<uuid>"}'Response
201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.
| Field | Type | Always present | Description |
|---|---|---|---|
| data | object | Yes | |
| data.op | object | Yes | |
| data.op.id | string (uuid) | Yes | |
| data.op.profile_id | string (uuid) | Yes | |
| data.op.profile_name | string | No | |
| data.op.profile_number | integer | No | (min -9007199254740991, max 9007199254740991) |
| data.op.set_id | string (uuid) | No | |
| data.op.set_name | string | Yes | |
| data.op.mode | "merge" | "replace" | Yes | |
| data.op.scope | "folder" | "all" | Yes | |
| data.op.folder | string | No | |
| data.op.state | "pending" | "applying" | "applied" | "failed" | "cancelled" | Yes | |
| data.op.rev | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data.op.session_id | string (uuid) | No | |
| data.op.result | object | No | |
| data.op.result.added | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data.op.result.duplicates | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data.op.result.removed | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data.op.reason | string | No | |
| data.op.created_at | string | Yes | |
| data.op.updated_at | string | Yes | |
| correlation_id | string (uuid) | Yes | |
| replayed | boolean | No | true when this command_id was already applied and the stored receipt came back |
Errors
| Code | HTTP | Retryable |
|---|---|---|
| UNAUTHENTICATED | 401 | No |
| FORBIDDEN | 403 | No |
| RATE_LIMITED | 429 | Yes |
| VALIDATION_FAILED | 422 | No |
| NOT_FOUND | 404 | No |
| CONFLICT | 409 | No |
| OUTCOME_UNKNOWN | 202 | Yes |
| DEPENDENCY_UNAVAILABLE | 503 | Yes |
| UNKNOWN | 500 | No |