Create Team Membership

POST

/teams/{teamId}/memberships

teams

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

teamId

string

required

Team unique ID.

Body Params application/json

string

required

New team member email.

name

string

optional

New team member name. Max length: 128 chars.

roles

array[string]

required

Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about roles and permissions. Max length for each role is 32 chars.

url

string

required

URL to redirect the user back to your app from the invitation email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

Examples

Responses

🟢201Membership

application/json

Body

Membership

$id

string

required

Membership ID.

confirm

boolean

required

User confirmation status, true if the user has joined the team or false otherwise.

string

required

User email address.

invited

integer <int32>

required

Date, the user has been invited to join the team in Unix timestamp.

joined

integer <int32>

required

Date, the user has accepted the invitation to join the team in Unix timestamp.

name

string

required

User name.

roles

array[string]

required

User list of roles

teamId

string

required

Team ID.

userId

string

required

User ID.

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

Get Team Memberships

Delete Team Membership