---
title: "Set competitor refresh paused"
method: POST
path: "/v1/commands/set_competitor_refresh_paused"
tags: ["Competitor research"]
---

# Set competitor refresh paused

`POST /v1/commands/set_competitor_refresh_paused`

## Request

- Base URL: `https://app.agentlinkops.com`
- URL: `https://app.agentlinkops.com/v1/commands/set_competitor_refresh_paused`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Shared command transport. All logical arguments in JSON; no query or Idempotency-Key header. See canonical operation reference.

## Headers

- `X-Workspace-ID` string

## Request body

- SetCompetitorRefreshPausedInput
  - `setId` string, required: set ID from create/list.
  - `expectedRevision` integer, required: Previously read revision; mismatches reject concurrent updates.
  - `paused` boolean, required: paused; see schema.

## Response `200`

Command result, including queued admission.

- SetCompetitorRefreshPausedOutput
  - `schedule` object, nullable, required
    - `v` 1, required
    - `set_id` string, required
    - `set_revision` integer, required
    - `cadence` 'weekly' | 'biweekly' | 'monthly', required
    - `paused` boolean, required
    - `last_started_at` string, date-time, nullable, required
    - `last_completed_at` string, date-time, nullable, required
    - `next_due_at` string, date-time, required
    - `member_limit` number, required
    - `budget_unit` 'owned_inventory_lookups', required
  - `latest_cycle` object, nullable, required
    - `id` string, required: Resource identifier returned by the operation.
    - `state` 'running' | 'completed' | 'partial' | 'failed', required: Saved lifecycle or evidence state, as enumerated for this record.
    - `planned_members` number, required
    - `captured` number, required
    - `failed` number, required
    - `pending` number, required
    - `started_at` string, required
    - `finished_at` string, nullable, required

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/2a712a1dcfa7?raw)