POpoll-the-people
Team Invitations

Invite a new member.

Changed on

Sends an invitation email to the specified address. The recipient must accept the invitation before they become a team member.

post/api/v1/teams/invitations

Request

Request body

emailstring email

Email address of the person to invite

role_idinteger

Role ID to assign to the invited member

Example request

{
  "email": "user@example.com",
  "role_id": 2
}

Response

Team invitation created successfully

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "email": "user@example.com",
    "role_id": 2,
    "team_id": 1,
    "created_at": "2023-04-30 16:43:53"
  }
}

Changes