@sumup/sdk
    Preparing search index...

    Class Members

    API resource for the Members endpoints.

    Endpoints to manage account members. Members are users that have membership within merchant accounts.

    Hierarchy

    • APIResource
      • Members
    Index
    _client: SumUp
    • Parameters

      • query: QueryParams | undefined
      • names: Record<string, string>

      Returns QueryParams | undefined

    • Adds a member to the merchant account with the specified roles.

      By default, sends an invitation email to the provided address. The recipient must accept the invitation to join the account. When is_managed_user is true, creates a managed user with the provided password and optional nickname and assigns the roles directly, without sending an invitation.

      Parameters

      Returns Promise<Member>

    • Updates a merchant member and returns the updated member.

      Providing roles replaces the member's assigned roles and can grant or revoke access. Providing metadata replaces the entire metadata object. For managed users, user.nickname changes the display name and user.password replaces the password. Updating the password also enables the managed user account.

      Parameters

      Returns Promise<Member>