> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retire competitor set
> Retire a competitor set to stop new inventory requests; preserve approved revisions and dated evidence.
`retire_competitor_set`
Retire a competitor set to stop new inventory requests; preserve approved revisions and dated evidence.
Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers still apply.
| Access | Behavior |
| ----------------- | ---------------------------------------------------------- |
| `discovery:write` | Writes or admits work; can change or remove existing state |
This operation changes saved state. Review its inputs and retry behavior before calling.
## Example request
Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.
```json MCP theme={null}
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "retire_competitor_set",
"arguments": {
"setId": "set_example",
"expectedRevision": 1
}
}
}
```
```bash CLI theme={null}
agentlinkops call retire_competitor_set --args '{"setId":"set_example","expectedRevision":1}'
```
```bash HTTP theme={null}
curl "$AGENTLINKOPS_API_URL/v1/commands/retire_competitor_set" \
-H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"setId":"set_example","expectedRevision":1}'
```
## Returned result
Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.
```json theme={null}
{
"v": 1,
"id": "set_example",
"revision": 1,
"workspace_id": "ws_example",
"project_id": "pr_example",
"approved_by": "user_example",
"approved_at": "2026-09-13T12:00:00.000Z",
"members": [
{
"id": "cm_customer",
"role": "customer",
"scope": {
"target_kind": "domain",
"target": "example.com",
"include_subdomains": true
}
},
{
"id": "cm_competitor",
"role": "competitor",
"scope": {
"target_kind": "domain",
"target": "competitor.example.org",
"include_subdomains": true
}
}
],
"current_revision": 1,
"retired_at": "2026-09-13T12:00:00.000Z"
}
```
## Input fields
Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.
| Field | Type | Presence | Meaning and constraints |
| ------------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| `setId` | string | Required | Identifier of the set returned by its create or list operation. minLength: 1; maxLength: 200 |
| `expectedRevision` | integer | Required | Revision last read by the caller; mismatches reject concurrent updates. minimum: 1; maximum: 9007199254740990 |
### Validation and omitted values
Requires the active current revision. Retiring stops new inventory requests while retaining approved revisions and saved evidence.
## Output fields
Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.
* **`v`** (number, required): must equal 1
* **`id`** (string, required): Resource identifier returned by the operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$"
* **`revision`** (integer, required): Optimistic concurrency revision; supply it as expectedRevision on the next write. minimum: 1; maximum: 9007199254740991
* **`workspace_id`** (string, required): Workspace that owns this record. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$"
* **`project_id`** (string, required): Project that owns this record. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$"
* **`approved_by`** (string, required): pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$"
* **`approved_at`** (string, required): format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]|\d\d\[13579]\[26]|\d\d0\[48]|\[02468]\[048]00|\[13579]\[26]00)-02-29|\d\{4}-(?:(?:0\[13578]|1\[02])-(?:0\[1-9]|\[12]\d|3\[01])|(?:0\[469]|11)-(?:0\[1-9]|\[12]\d|30)|(?:02)-(?:0\[1-9]|1\d|2\[0-8])))T(?:(?:\[01]\d|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$"
* **`members`** (array, required): minItems: 2; maxItems: 11
* **`current_revision`** (number, required).
* **`retired_at`** (string / null, required).
| Field | Type | Presence | Meaning and constraints |
| ------------------------------------ | ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `v` | number | Required | must equal 1 |
| `id` | string | Required | Resource identifier returned by the operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `revision` | integer | Required | Optimistic concurrency revision; supply it as expectedRevision on the next write. minimum: 1; maximum: 9007199254740991 |
| `workspace_id` | string | Required | Workspace that owns this record. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `project_id` | string | Required | Project that owns this record. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `approved_by` | string | Required | pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `approved_at` | string | Required | format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]\|\d\d\[13579]\[26]\|\d\d0\[48]\|\[02468]\[048]00\|\[13579]\[26]00)-02-29\|\d\{4}-(?:(?:0\[13578]\|1\[02])-(?:0\[1-9]\|\[12]\d\|3\[01])\|(?:0\[469]\|11)-(?:0\[1-9]\|\[12]\d\|30)\|(?:02)-(?:0\[1-9]\|1\d\|2\[0-8])))T(?:(?:\[01]\d\|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$" |
| `members` | array | Required | minItems: 2; maxItems: 11 |
| `members[].id` | string | Required | Resource identifier returned by the operation. pattern: "^\[a-zA-Z0-9\_-]\{1,128}\$" |
| `members[].role` | string | Required | values: "customer", "competitor" |
| `members[].scope` | object | Required | additional fields rejected |
| `members[].scope.target_kind` | string | Required | values: "domain", "exact\_url" |
| `members[].scope.target` | string | Required | minLength: 1; maxLength: 4096 |
| `members[].scope.include_subdomains` | boolean | Required | |
| `current_revision` | number | Required | |
| `retired_at` | string / null | Required | |
[Download input schema](/schemas/retire_competitor_set.input.json) · [Download output schema](/schemas/retire_competitor_set.output.json)
## Errors and retries
The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict.
See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.
## HTTP resource routes
These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See [HTTP route details](/reference/http/routes).
| Method and route | Success | Details |
| ------------------------------------ | ------- | --------------------------------------------- |
| `DELETE /v1/competitor-sets/{setId}` | 200 | Remaining arguments go in a JSON object body. |
## Continue
[get\_competitor\_set](/reference/commands/get_competitor_set)
Follow the [related workflow](/guides/competitor-research), inspect [capability status](/capability-status), or return to the [command index](/reference/index).