Skip to main content
POST
SetMonitoredCompanyState

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Headers

Idempotency-Key
string

Optional client-generated idempotency key. Retrying a POST with the same key and an identical request body replays the original response (only the status, body, and Content-Type are reproduced) instead of re-executing; reusing the key with a different body is rejected with 422. For mutations this avoids duplicating the side effect, while for batch-read POSTs it replays a cached snapshot that can be up to 24 hours stale. Keys are scoped per authenticated caller (falling back to the source IP for unauthenticated endpoints) and retained for 24 hours.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json
companyId
string
required
Pattern: ^cm_company_[0-9A-HJKMNP-TV-Z]{26}$
targetLifecycle
enum<string>
required

MonitoredCompanyLifecycle is the customer-visible company lifecycle.

Available options:
MONITORED_COMPANY_LIFECYCLE_UNSPECIFIED,
MONITORED_COMPANY_LIFECYCLE_ACTIVE,
MONITORED_COMPANY_LIFECYCLE_PAUSED,
MONITORED_COMPANY_LIFECYCLE_REMOVED

Response

Successful response

company
object

MonitoredCompany is a compact account-scoped portfolio row.

snapshotRequired
boolean