/api/public/v1/shares/{id}/revokeshares.revoke
Withdraw a copy that has not been delivered yet; a half-done import on the recipient side is removed. A delivered copy cannot be recalled or erased.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
idpath | string (uuid) | Yes | Share 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/shares/<id>/revoke" \
-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.package | object | Yes | |
| data.package.id | string (uuid) | Yes | |
| data.package.state | "preparing" | "available" | "importing" | "delivered" | "declined" | "revoked" | "expired" | "failed" | Yes | |
| data.package.profile_name | string | Yes | |
| data.package.os | "windows" | "linux" | Yes | |
| data.package.source_revision | integer | No | Committed revision the copy is pinned to (absent for configuration-only copies) (min -9007199254740991, max 9007199254740991) |
| data.package.categories | array<"cookies" | "local_storage" | "indexed_db" | "service_workers" | "extensions" | "bookmarks" | "history" | "open_tabs" | …> | Yes | Browser data carried beyond the configuration |
| data.package.recipient_email | string | Yes | |
| data.package.message | string | No | |
| data.package.expires_at | string (date-time) | Yes | |
| data.package.created_at | string (date-time) | Yes | |
| data.package.delivered_at | string (date-time) | No | |
| data.package.ended_at | string (date-time) | No | |
| data.package.failure | object | No | |
| data.package.failure.code | string | Yes | |
| data.package.failure.message | string | No | |
| data.package.progress | object | No | |
| data.package.progress.waiting_for_machine | boolean | Yes | |
| data.package.progress.phase | string | No | |
| data.package.progress.pct | integer | No | (min -9007199254740991, max 9007199254740991) |
| data.package.progress.attempts | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data.package.profile_id | string (uuid) | No | Absent once the source profile was deleted |
| data.package.created_by_email | string | No | |
| 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 |