Send a user invitation

​

Sends an email invitation to join the system. Requires role (admin, user, supervisor, guest, or client) and optional team/category assignments. Generates a unique registration link valid until accepted or revoked.

Body·
required
application/json
  • accepted
    Type: integer
    min:  
    0
    max:  
    1

    Whether the invited user has already accepted the invitation (0 = pending, 1 = accepted)

  • categories
    Type: array integer[]

    IDs of categories the invited user will be assigned to upon acceptance

  • email
    Type: string

    Invited user mail

  • hash
    Type: string

    One-time token embedded in the invitation link sent to the invited user

  • role
    Type: string enum

    Invited user role

    values
    • user
    • admin
  • teams
    Type: array integer[]

    IDs of teams the invited user will be added to upon acceptance

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/user/invitation
curl https://test.boost.space/api/user/invitation \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "email": "user@example.com",
  "role": "user",
  "hash": "string",
  "created": "2026-01-15T09:30:00Z",
  "accepted": 1,
  "teams": [
    1
  ],
  "categories": [
    1
  ]
}'

{
  "id": 42,
  "email": "user@example.com",
  "role": "user",
  "hash": "string",
  "created": "2026-01-15T09:30:00Z",
  "accepted": 1,
  "teams": [
    1
  ],
  "categories": [
    1
  ]
}

Create record