Skip to content
Catalyzed Docs
Create Account Sign In

Create team invite

POST
/team-invites

Request Body

Section titled “Request Body ”
object
teamId
required
string
>= 1 characters
email
required
string format: email
role
required
string
Allowed values: admin member
expiresInDays
integer
default: 7 >= 1 <= 90

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Team invite created successfully

object
teamInvite
required
object
teamInviteId
required
string
teamId
required
string
email
required
string format: email
userId
required
string
nullable
role
required
string
Allowed values: admin member
expiresAt
required
string format: date-time
createdByUserId
required
string
userInviteId
required
string
nullable
acceptedAt
required
string format: date-time
nullable
declinedAt
required
string format: date-time
nullable
revokedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
inviteUrl
required
string format: uri

403

Section titled “403 ”

Forbidden - insufficient permissions to invite users to this team

404

Section titled “404 ”

Team not found

409

Section titled “409 ”

Conflict - pending invite already exists for this email/team combination