---
title: "Control Run"
method: POST
path: "/companies/{company_id}/activity/{kind}/{run_id}/{action}"
tags: ["activity"]
---

# Control Run

`POST /companies/{company_id}/activity/{kind}/{run_id}/{action}`

## Request

- Base URL: `https://app.zalster.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.zalster.com/companies/{company_id}/activity/{kind}/{run_id}/{action}`
- Auth: none declared

Pause, continue, stop, or run again.

Answers with the run as it is now — for ``rerun``, with the new run. A
request the run is not in a state for is a 409 whose detail says why, in
words for the person who asked.

## Path parameters

- `company_id` string, uuid, required: Company id
- `kind` 'import' | 'export' | 'render' | 'images', required
- `run_id` string, uuid, required
- `action` 'pause' | 'resume' | 'cancel' | 'rerun', required

## Response `200`

Successful Response

- ActivityOut: One run of any kind, in the terms they share.
  - `kind` string, required
  - `id` string, uuid, required
  - `status` string, required
  - `subject_id` string, uuid, required
  - `subject` string, nullable, required
  - `trigger` string, nullable, required
  - `done` integer, required
  - `total` integer, required
  - `failed` integer, required
  - `error_message` string, nullable, required
  - `job_id` string, nullable, required
  - `started_at` string, date-time, nullable, required
  - `finished_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable, required
  - `is_running` boolean, required
  - `is_paused` boolean, required
  - `control` string, nullable, required
  - `progress` ActivityProgressOut, required: How far a run has got, in the terms of the step it is on.
    - `step` string, nullable, required
    - `done` integer, required
    - `total` integer, nullable, required
    - `unit` string, required
    - `rows` integer, nullable
    - `batch` integer, nullable
    - `batches` integer, nullable
  - `actions` ActivityActionsOut, required: What a person may ask of the run right now.
    - `pause` boolean, required
    - `resume` boolean, required
    - `cancel` boolean, required
    - `rerun` boolean, required
    - `notice` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zalster/apis/zalster-feed-processor.md) - [All operations](https://skmtc.dev/zalster/apis/zalster-feed-processor/llms.txt) - [OpenAPI document](https://skmtc.dev/zalster/apis/zalster-feed-processor/revisions/d0b9dc66ad36?raw)