Overview

This node operation creates a membership in a specified team within the Appwrite platform. It allows inviting a user to join a team either by their email or user ID, assigning specific roles to the user, and optionally providing a URL to redirect the user after they accept the invitation. This operation is useful for managing team memberships programmatically, such as adding new contributors or members to a project team.

Use Case Examples

1. Inviting a new user to a team by email with the role of 'member'.
2. Adding an existing user to a team by their user ID and assigning multiple roles like 'member' and 'contributor'.
3. Sending an invitation with a custom redirect URL after acceptance.

Properties

Output

JSON

• membershipId - The unique identifier of the created team membership.
• teamId - The ID of the team to which the membership belongs.
• userId - The ID of the user who was added to the team.
• email - The email of the invited user, if used for invitation.
• roles - The roles assigned to the user in the team membership.
• invitationUrl - The URL provided for redirecting the user after accepting the invitation.

Dependencies

• Appwrite API key credential for authentication

Troubleshooting

• Ensure that either Email or User ID is provided; both cannot be empty.
• Verify that the Team ID is correct and that the authenticated user has permission to add members to the team.
• Check that the roles provided are valid and recognized by the Appwrite team management system.
• If the invitation URL is provided, ensure it is a valid and reachable URL to avoid redirect issues.

Links

• Appwrite Teams API - Create Membership - Official documentation for creating team memberships using the Appwrite API.