Team

Invite a member

Records a pending invitation and returns the link that accepts it. Upcheck does not email it; send the link yourself. Invitations expire after seven days.

post/v1/team/invitations

Request

  • Base URL: https://api.upcheck.so
  • URL: https://api.upcheck.so/v1/team/invitations
  • Auth: HTTP bearer

Request body

emailstring email required
role'admin' | 'member'

Example request

{
  "email": "colleague@example.com"
}

Response

The invitation and its accept link.

idstring required

Opaque identifier.

acceptUrlstring required

Send this to the invitee; opening it joins the organization.

Example response

{
  "id": "9b1d..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.