HEhexclave
Teams

Send an email to invite a user to a team

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.

post/team-invitations/send-code

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/team-invitations/send-code
  • Auth
    none declared

Request body

team_idstring required

The unique identifier of the team

emailstring required

The email of the user to invite.

callback_urlstring required

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.

Example request

{
  "team_id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
  "email": "johndoe@example.com",
  "callback_url": "https://example.com/handler/team-invitation"
}

Response

Successful response

successboolean required
idstring required

Changes

No recorded changes to this operation across all 28 revisions of this API.