Set a member's availability

Turns transferred calls on or off for a member, in every account of the organization: away or offline, optionally until a moment (then the member is available again by itself), or available. The member may set any status. An owner or admin may set another member away or offline, and may make them available again only if the member did not turn calls off themselves.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

memberIdstringRequiredformat: "uuid"

Membership ID

Request

This endpoint expects an object.

statusenumRequired

available, away or offline

Allowed values:

untildatetime or nullOptional

For away/offline: when it ends by itself (RFC 3339, in the future, at most 30 days ahead). Omit for "until I change it". Not allowed with available.

Response

Availability set

busyboolean

On a transferred call right now; not offered another one

memberIdstringformat: "uuid"

Membership ID

statusenum

The status in force now (an away/offline whose end time passed reads as available)

Allowed values:

userIdstringformat: "uuid"

User ID

reasonstring or nullOptional

Why the platform set it (missed_calls), with source: auto

sourceenum or nullOptional

Who set the status: the member, an owner/admin, or the platform (auto, after missed calls).

Allowed values:

untildatetime or nullOptional

When away/offline ends by itself; null = until changed

updatedAtdatetime or nullOptional

When the current away/offline was set

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error