is_active

Name

Modifier & Defaults

Type

Description

is_active

Default:
true

Boolean

Can be modified only when the Item has a status of RUNNING, PAUSED or PENDING_APPROVAL.

Determines whether the Item is active (ready to be served) or not. You can:

  • Pause an active Item immediately.
  • Flag a pending Item to be paused upon approval.

This field affects the status of the Item:

If status = RUNNING:

Setting is_active to false changes status to PAUSED.

If status = PAUSED:

Setting is_active to true changes status to RUNNING.

If status = PENDING_APPROVAL:

Setting is_active to false does not change the status (immediately).
However, upon approval, status will be set to PAUSED.

Setting is_active to true (default value) does not change the status (immediately).
However, upon approval, status will be set to RUNNING.