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

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
​
group_invite_link
string
required

Group invite link to join

Example:

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

Response

Successfully joined group

​
success
boolean
Example:

true

​
message
string
Example:

"Successfully joined group"