Ctrl+K

Freeze an enterprise

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

Freezes the specified enterprise for the given duration. Callable by internal services without user authentication or permissions.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise public ID
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

durationOne ofrequired
Duration in seconds, or "max" for approximately 1000 years
reason string
Optional reason for the freeze
Min length: >= 1 characters

200 Response

timeOne of
When the freeze started
expiresOne of
When the freeze will end
reason string
The reason the entity was frozen
frozenBy string
The user that froze the entity
unFrozenBy string
The user that unfroze the entity

400 Response

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

404 Response

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

500 Response

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