Blocks a company admin login.

patch

https://example.com/wep/companies/{companyId}/logins/block

Blocks an existing company admin login for companyId and returns the refreshed admin record.

Use block to identify the target by AdminId, LoginId, or Email. When multiple identifiers are supplied, AdminId takes precedence over LoginId, and LoginId takes precedence over Email.

Repeated calls for the same admin keep the login blocked and return the current blocked state.

Access: System, Admin, and ClientAdmin users only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Identifier of the client company whose admin login should be blocked.

Body Params

Request payload that selects which company admin login to block.

Request payload for blocking a company admin login in API version 2.0.

loginId

int32 | null

adminId

int32 | null

Company admin identifier for the client user record.

string | null

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

jwt

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200OK