Skip to main content
POST
https://api.folkyn.com
/
api
/
v1
/
users
/
invitations
Invite Team User
curl --request POST \
  --url https://api.folkyn.com/api/v1/users/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "admin@example.com",
  "first_name": "Alex",
  "last_name": "Martin",
  "role": "team-admin",
  "job_title": "HR Manager",
  "invite_locale": "fr"
}
'
{
  "data": {
    "invitation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "status": "pending",
    "email_sent": true,
    "resent": true
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <your_api_key>

Body

application/json
​
email
string<email>
required
​
first_name
string
required
​
last_name
string
required
​
role
enum<string>
required
Available options:
team-admin,
team-member
​
job_title
string
​
tag_ids
string<uuid>[]
​
team_ids
string<uuid>[]

Organizational team unit UUIDs on the invitation.

​
invited_by_member_id
string<uuid>

Team member profile UUID shown as email sender; defaults to first active team-admin.

​
invite_locale
enum<string>
Available options:
fr,
en

Response

Invitation created

​
data
object