Skip to main content
POST
https://api.folkyn.com
/
api
/
v1
/
freelancers
/
invitations
Invite Freelancer
curl --request POST \
  --url https://api.folkyn.com/api/v1/freelancers/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "job_title": "Senior Developer",
  "tag_ids": [
    "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee"
  ],
  "invite_locale": "en"
}
'
{
  "data": {
    "invitation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "status": "pending",
    "email_sent": true,
    "is_existing_freelancer": 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
​
job_title
string

Optional job title stored on the invitation.

​
referent_id
string<uuid>

Active team member profile UUID as referent.

​
tag_ids
string<uuid>[]
​
team_ids
string<uuid>[]

Organizational team (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>

Locale for the invitation email (fr or en).

Available options:
fr,
en

Response

Invitation created

​
data
object