Skip to content

Add a member to a group

POST
/api/v4/groups/{id}/invitations

Adds a member to a group. You can specify a user ID or invite a user by email.

id
required
string

The group ID

Media type application/json
object
access_level
required

A valid access level (defaults: 30, developer access level)

integer
Allowed values: 10 15 20 25 30 40 50 5
email

The email address to invite, or multiple emails separated by comma

Array<string>
nullable
user_id

The user ID of the new member or multiple IDs separated by commas.

Array<string>
nullable
expires_at

Date string in the format YEAR-MONTH-DAY

string format: date-time
nullable
invite_source

Source that triggered the member creation process

string
default: invitations-api nullable
member_role_id

The ID of a member role for the invited user

integer
nullable

Created

Media type application/json
object
access_level
string
created_at
string
expires_at
string
invite_email
string
invite_token
string
user_name
string
created_by_name
string
Example generated
{
"access_level": "example",
"created_at": "example",
"expires_at": "example",
"invite_email": "example",
"invite_token": "example",
"user_name": "example",
"created_by_name": "example"
}

Bad Request

Not Found