Change a member's role (`owner`, `member`, `viewer`), or give them a `custom` list of permissions. Needs `people.manage`; only an owner makes, changes or removes an owner, and nobody gives a permission they do not hold. The last owner cannot be demoted. The person is emailed unless they changed their own role

patch/v1/organization/members/{userId}

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/organization/members/{userId}
  • Auth: HTTP bearer

Path parameters

userIdstring required

Request body

OR

Response

The member after the change. Asking for the role they already have changes nothing.

idstring required

The person's user id: how a case names its complaint signer, and the userId of the member routes.

membershipIdstring
namestring nullable required
emailstring
role'owner' | 'member' | 'viewer' | 'custom' required

The person's role in the organization.

permissionsstring[]

What the person may change in the organization: the preset of their role, or the list of a custom role.

caseEmails'all' | 'mine' | 'none'

Which of the organization's case emails the person gets. On the caller's own row only.

joinedAtstring date-time
lastLoginAtstring date-time nullable

The person's last sign-in. Only to people who manage people.

youboolean

Whether this is the caller.

disabledboolean

Whether the platform disabled the account: a disabled person performs nothing.

Changes

No recorded changes to this operation across all 1 revision of this API.