Groups

Invite user to group

POST
/groups/{group_name}/invitations

Sends an invitation email to join the group and returns the join link. With send_email set to false, only the link is created (no email is sent), so the inviter can share it directly. Only group owners or admins can invite new members.

Authorization

token_auth
headerAuthorizationBearer <token>

Token-based authentication using access tokens.

Path Parameters

group_name*string

Request Body

application/json
  1. body
email*Email
Formatemail
callback_url*Callback Url
request_billing_change?Request Billing Change
Defaultfalse
send_email?Send Email

Send the invitation email. When false, only the join link is created and returned.

Defaulttrue

Response Body

Successful Response

application/json
  1. response
message*Message
join_url*Join Url

Link the invitee opens to join the group. Bound to the invited email.

expires_in_hours*Expires In Hours
curl -X POST "https://example.com/groups/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "callback_url": "string"  }'
{  "message": "string",  "join_url": "string",  "expires_in_hours": 0}