Employers

Deactivate an employer

Changed on

Disables sign-in and revokes all sessions. Company memberships, claims, and jobs are preserved for a later reactivate. Idempotent: an already-deactivated employer returns 200 with the unchanged employer. Requires employers.manage. The request is idempotent when an Idempotency-Key header is supplied.

post/employers/{id}/deactivate

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/employers/{id}/deactivate
  • Auth: HTTP bearer

Path parameters

idstring required

The employer id.

Response

Employer deactivated. deactivatedAt is set. Sign-in is blocked and sessions are revoked.

idstring required

Unique identifier for the employer.

object'employer' required

String representing the object's type.

emailstring required

The employer's email address.

displayNamestring nullable required
avatarUrlstring nullable required
emailVerifiedAtstring nullable required
createdAtstring required
lastActiveAtstring nullable required

ISO-8601 timestamp of the last activity on the board (a sign-in or signed-in use), to the hour, or null.

deactivatedAtstring date-time nullable required

ISO 8601 timestamp when sign-in was disabled, or null when the employer can sign in. Deactivate revokes all sessions and blocks sign-in; company memberships, claims, and jobs are preserved. Reactivate restores sign-in; the employer signs in again to establish a new session.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status