> ## 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.
# Configure competitor refresh
> Schedule inventory lookups from the stored corpus for an approved competitor revision.
`configure_competitor_refresh`
Schedule inventory lookups from the stored corpus for an approved competitor revision. Set cadence and a member limit. The first cycle is due immediately. No paid supplier request or monitoring enrollment.
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": "configure_competitor_refresh",
"arguments": {
"setId": "set_example",
"expectedRevision": 1,
"cadence": "weekly",
"memberLimit": 1
}
}
}
```
```bash CLI theme={null}
agentlinkops call configure_competitor_refresh --args '{"setId":"set_example","expectedRevision":1,"cadence":"weekly","memberLimit":1}'
```
```bash HTTP theme={null}
curl "$AGENTLINKOPS_API_URL/v1/commands/configure_competitor_refresh" \
-H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"setId":"set_example","expectedRevision":1,"cadence":"weekly","memberLimit":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}
{
"schedule": {
"v": 1,
"set_id": "set_example",
"set_revision": 1,
"cadence": "weekly",
"paused": false,
"last_started_at": null,
"last_completed_at": null,
"next_due_at": "2026-09-13T12:00:00.000Z",
"member_limit": 1,
"budget_unit": "owned_inventory_lookups"
},
"latest_cycle": null
}
```
## 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. maximum: 9007199254740991; exclusiveMinimum: 0 |
| `cadence` | string | Required | The cadence value; allowed values and bounds are specified in this schema. values: "weekly", "biweekly", "monthly" |
| `memberLimit` | integer | Required | The member limit value; allowed values and bounds are specified in this schema. minimum: 1; maximum: 11 |
### Validation and omitted values
cadence and memberLimit are required explicit choices. Initial configuration is due immediately; this does not guarantee a completion time. Updating the same revision preserves its existing due position and unpauses the schedule.
## 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.
* **`schedule`** (object / null, required).
* **`latest_cycle`** (object / null, required).
| Field | Type | Presence | Meaning and constraints |
| ------------------------------ | ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `schedule` | object / null | Required | |
| `schedule.v` | number | Required | must equal 1 |
| `schedule.set_id` | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128 |
| `schedule.set_revision` | integer | Required | maximum: 9007199254740991; exclusiveMinimum: 0 |
| `schedule.cadence` | string | Required | values: "weekly", "biweekly", "monthly" |
| `schedule.paused` | boolean | Required | |
| `schedule.last_started_at` | string / null | Required | |
| `schedule.last_completed_at` | string / null | Required | |
| `schedule.next_due_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))\$" |
| `schedule.member_limit` | number | Required | |
| `schedule.budget_unit` | string | Required | must equal "owned\_inventory\_lookups" |
| `latest_cycle` | object / null | Required | |
| `latest_cycle.id` | string | Required | Resource identifier returned by the operation. |
| `latest_cycle.state` | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: "running", "completed", "partial", "failed" |
| `latest_cycle.planned_members` | number | Required | |
| `latest_cycle.captured` | number | Required | |
| `latest_cycle.failed` | number | Required | |
| `latest_cycle.pending` | number | Required | |
| `latest_cycle.started_at` | string | Required | |
| `latest_cycle.finished_at` | string / null | Required | |
[Download input schema](/schemas/configure_competitor_refresh.input.json) · [Download output schema](/schemas/configure_competitor_refresh.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 |
| ----------------------------------------- | ------- | --------------------------------------------- |
| `PUT /v1/competitor-sets/{setId}/refresh` | 200 | Remaining arguments go in a JSON object body. |
## Continue
[get\_competitor\_refresh](/reference/commands/get_competitor_refresh)
Follow the [related workflow](/guides/competitor-research), inspect [capability status](/capability-status), or return to the [command index](/reference/index).