Skip to main content
POST
Stop a policy

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId
string
required

the policy id

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

Body

application/json
reason
string
required

Stop reason. The accepted values are defined per product; read them from the product configuration in GET /config/{productId}. An unlisted value fails with INVALID_STOP_REASON.

details
object[]

Response

The response is of type object.