Skip to content

Put Agent Operating Model

PUT
/agent/operators/operating-model

Replace the organisation’s operating-model override. PUT SEMANTICS.

The whole document is replaced: a key absent from override is REMOVED, not left alone, and an empty object resets the org to graph8’s defaults. That is the app’s behaviour and this does not soften it - a partial-update spelling here would make the same body mean two different things on two surfaces.

This is a policy document, not a switch, which is why it is tiered write while /enabled is not: it describes the org, and an operator has to be turned on separately before anything reads it unattended.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of OperatingModelUpdate.

override is an open object and stays that way. It is the organisation’s operating-model document - which motions it runs, what it calls them - and it is validated by the service against the live model definition rather than by a shape frozen into this contract. Pinning it would refuse a key a newer platform version understands.

object
override
required

The organisation’s operating-model override, REPLACED WHOLE. This is a PUT: keys absent from the body are removed, not left alone. Read GET /agent/operators/operating-model first and send it back modified.

object
key
additional properties
any

Responses

200

Successful Response

object
data
required

An open envelope for one operator answer.

Open because an operator’s health snapshot, scorecard and catalog are per-operator documents whose shape follows what that operator monitors - the revenue operator reports different checks from the deliverability one, and both grow. On an OVERSIGHT surface a dropped field reads as “nothing to worry about” rather than “we did not tell you”, which is the failure mode worth designing against.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string