Disable the WorkInbox module lifecycle.

POST

/api/workspace/admin/work-inbox/disable

curl --request POST \
  --url https://example.com/api/workspace/admin/work-inbox/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

• WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Disable WorkInbox module lifecycle.

object

Reason

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "Reason": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Disable WorkInbox module lifecycle.

object

Reason

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "Reason": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Disable WorkInbox module lifecycle.

object

Reason

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "Reason": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

Media typeapplication/json

object

Data

WorkInbox administration detail response.

object

Summary

Workspace lifecycle summary for the WorkInbox module surface.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

AllowedActions

Allowed lifecycle actions for the WorkInbox module surface.

object

CanEnable

boolean

CanDisable

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

WorkInbox administration detail response.

object

Summary

Workspace lifecycle summary for the WorkInbox module surface.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

AllowedActions

Allowed lifecycle actions for the WorkInbox module surface.

object

CanEnable

boolean

CanDisable

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

Media typeapplication/json

object

Data

WorkInbox administration detail response.

object

Summary

Workspace lifecycle summary for the WorkInbox module surface.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

AllowedActions

Allowed lifecycle actions for the WorkInbox module surface.

object

CanEnable

boolean

CanDisable

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}