Freeze the enterprise

post/api/v2/enterprise/{enterpriseId}/freeze

Path Parameters

  • enterpriseIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

duration integer
seconds to freeze the enterprise for
Default: 3600

200 Response

time string <date-time>
When the freeze started
expires string <date-time>
When the freeze will end

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code