Skip to main content
PUT
Set a member Away
Sets one member Away, for example someone who left without turning off their switch. Stages that only assign to Active members stop giving them new leads until they turn Active again themselves.

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

What happens

  • The member is Away, with changed_by: admin.
  • Leads they already own keep their owner.
  • A member who is already Away stays as they were: changed_at and changed_by keep the earlier values.
  • No member of this account with that ID returns 404 MEMBER_NOT_FOUND.
  • There is no way to set someone else Active. Active is always the member’s own choice.
  • With the Nexor MCP, use set_member_away.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

user_id
string<uuid>
required

The member's user ID, as returned in members[].user_id by GET /team/availability or by GET /team.

Body

application/json
availability
enum<string>
required

Only away is accepted.

Available options:
away

Response

The member is Away.

user_id
string<uuid>
required
availability
enum<string>
required
Available options:
away
changed_at
string<date-time> | null
required

When the member went Away. If they were already Away, the earlier time is kept.

changed_by
enum<string> | null
required

admin when this call set them Away. If they were already Away, the earlier value is kept.

Available options:
self,
idle,
admin
Last modified on October 21, 2026