Create Team Membership

POST

/teams/{teamId}/memberships

Use this endpoint to invite a new member to join your team. If initiated from Client SDK, an email with a link to join the team will be sent to the new member's email address if the member doesn't exist in the project it will be created automatically. If initiated from server side SDKs, new member will automatically be added to the team.

Use the 'URL' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the Update Team Membership Status endpoint to allow the user to accept the invitation to the team. While calling from side SDKs the redirect url can be empty string.

Please note that in order to avoid a Redirect Attacks the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://appwrite.io/v1/teams//memberships' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "string",
    "name": "string",
    "roles": [
        "string"
    ],
    "url": "string"
}'

Response Example

{
    "$id": "string",
    "confirm": true,
    "email": "string",
    "invited": 0,
    "joined": 0,
    "name": "string",
    "roles": [
        "string"
    ],
    "teamId": "string",
    "userId": "string"
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Membership

application/json

Body

Modified at 2023-08-16 07:28:14

Get Team Memberships

Delete Team Membership