Skip to main content
POST
/
teams
/
join
Join Team
curl --request POST \
  --url https://api.village.do/v1/teams/join \
  --header 'Content-Type: application/json' \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>' \
  --data '{
  "team_invite_link": "https://village.do/invite/xyz789"
}'
{
  "success": true,
  "message": "Successfully joined team"
}

Authorizations

​
x-access-token
string
header
required

JWT token obtained from /users/authorization endpoint

Headers

​
user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village. Not needed when using user token authentication.

Body

application/json
​
team_invite_link
string
required

Team invite link to join

Example:

"https://village.do/invite/xyz789"

Response

Successfully joined team

​
success
boolean
Example:

true

​
message
string
Example:

"Successfully joined team"