Members

Suspend a member

Changed on

Suspends a member: they keep their role but lose all permission evaluations. The primary owner cannot be suspended.

post/members/{userId}/suspend

Request

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

Path parameters

userIdstring required

The user ID of the member.

Response

Successful response.

idstring required

Unique identifier for the membership.

object'member' required

String representing the object's type.

userIdstring required

Identifier of the user behind the member.

emailstring required

The member's email address.

namestring required

The member's display name.

avatarUrlstring nullable required

URL of the member's avatar, or null if none is set.

rolestring required

The member's role in the account.

suspendedboolean required

Whether the member is currently suspended.

joinedAtstring required

ISO-8601 timestamp of when the member joined the account.

isPrimaryOwnerboolean required

Whether the member is the account primary owner.

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