P
ProFormsDocs

Invite Member

Invite a new team member to your organization. They'll receive an email with a link to set their password.

team.invite
POST/v1/team

Request Body

name*string

Member's full name

email*string

Email address (must be unique)

role*string

Role: admin, editor, or viewer

permissionsstring[]

Custom permissions array (overrides role preset)

sendInviteboolean

Send welcome email with password setup link (default: true)

Example Request

curl
curl -X POST "https://proforms.io/api/v1/team" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sarah Chen",
    "email": "sarah@example.com",
    "role": "editor",
    "permissions": ["forms.view", "forms.edit", "submissions.view", "submissions.export"]
  }'

Response

200 OK
{
  "success": true,
  "data": {
    "id": "u_new123",
    "name": "Sarah Chen",
    "email": "sarah@example.com",
    "role": "editor",
    "permissions": [
      "forms.view",
      "forms.edit",
      "submissions.view",
      "submissions.export"
    ],
    "createdAt": "2026-02-17T11:00:00.000Z"
  }
}
💡
Roles are just presets that auto-fill permissions. You can customize individual permissions for any user regardless of their role. See Authentication for the full permissions list.

Resend Invitation

Resend the welcome email to a pending invited user. Generates a new activation token valid for 48 hours. Requires admin or owner role.

POST/v1/team/:userId/resend-invite
curl
curl -X POST "https://proforms.io/api/v1/team/u_abc123/resend-invite" \
  -H "Authorization: Bearer pf_your_api_key"
200 OK
{
  "success": true,
  "data": {
    "message": "Invitation email sent successfully",
    "emailSent": true
  }
}
⚠️
Only works for users with invited status. Returns 404 if the user has already activated their account.

Revoke Invitation

Cancel a pending invitation and permanently delete the invited user record. Requires admin or owner role.

POST/v1/team/:userId/revoke-invite
curl
curl -X POST "https://proforms.io/api/v1/team/u_abc123/revoke-invite" \
  -H "Authorization: Bearer pf_your_api_key"
200 OK
{
  "success": true,
  "data": {
    "message": "Invitation revoked successfully"
  }
}