Skip to main content
POST
Send email invitations to potential users to join your platform.

Request Headers

string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

Request Body

array
required
Array of email addresses to send invitations to
string
Custom invitation message
string
default:"learner"
Role to assign to users when they accept the invitation
array
Array of group IDs to add users to upon acceptance
array
Array of course IDs to assign to users upon acceptance
integer
Timestamp for course assignment deadlines

Response

Array of created invitation objects.
integer
required
Invitation ID
string
required
Recipient email address
integer
required
Creation timestamp
string
required
Signup URL for recipient

Notes

  1. Email requirements:
  • Must be valid email format
  • Cannot be already registered users
  • One invitation per email address
  1. Role assignment:
  • Default role is “learner”
  • Role must exist in system
  • Custom roles must be valid
  1. URL expiration:
  • Signup URLs are valid for 7 days
  • New invitations invalidate old ones