Skip to main content
PATCH
Change the idle time
Sets the idle time for the whole account: how long a member can go without using the app before they go Away on their own. The default is 50 minutes, so a long phone call does not set anyone Away. The check runs every 5 minutes, so a member goes Away up to 5 minutes after passing the idle time.

Before you start

  • MCP keys need workflows:write. Full-access REST keys need nothing else.
  • A key that belongs to a person (for example an MCP key) works only for owners and admins. Otherwise it returns 403 OWNER_OR_ADMIN_REQUIRED.
  • If team availability is not turned on for the account, it returns 403 TEAM_AVAILABILITY_UNAVAILABLE.

Request

The response returns the saved idle_minutes. Automatic Away never turns anyone Active, and it never moves leads a member already owns.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
idle_minutes
integer
required

Minutes without using the app before automatic Away.

Required range: 10 <= x <= 480

Response

The idle time was saved.

idle_minutes
integer
required
Required range: 10 <= x <= 480
Last modified on October 21, 2026