Send an email to invite a user to a team | Stack Auth Documentation

The user receiving this email can join the team by clicking on the link in the email. If the user does not have an account yet, they will be prompted to create one.

Request

This endpoint expects an object.

team_idstringRequired

The unique identifier of the team

emailstringRequired

The email of the user to invite.

callback_urlstringRequired

The base callback URL to construct an invite link with. A query parameter code with the verification code will be appended to it. The page should then make a request to the /team-invitations/accept endpoint.

Response

Successful response

successboolean

idstring

1	import requests
2
3	url = "https://api.stack-auth.com/api/v1/team-invitations/send-code"
4
5	payload = {
6	"team_id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
7	"email": "johndoe@example.com",
8	"callback_url": "https://example.com/handler/team-invitation"
9	}
10	headers = {"Content-Type": "application/json"}
11
12	response = requests.post(url, json=payload, headers=headers)
13
14	print(response.json())