Update Freelancer Team Fields

PATCH

https://api.folkyn.com

api

freelancers

{id}

curl --request PATCH \
  --url https://api.folkyn.com/api/v1/freelancers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ERP-F-88421",
  "note": "Preferred for Q3 staffing"
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "external_id": "<string>",
    "job_title": "<string>",
    "note": "<string>",
    "referent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>"
    },
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "depth": 2,
        "path": "<string>",
        "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "kyc_complete": true,
    "master_agreement_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "first_name": "<string>",
    "last_name": "<string>"
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer <your_api_key>

Path Parameters

string<uuid>

required

Freelancer profile UUID (not a pending invitation id).

Body

application/json

At least one field required. tag_ids and team_ids replace the full assignment for this team. referent_id can be reassigned to another team member but cannot be cleared.

external_id

string | null

Team-stored external identifier; null clears it.

note

string | null

Internal team note on the freelancer; null clears it.

tag_ids

string<uuid>[]

Team tag UUIDs to assign (replaces existing tags for this team).

team_ids

string<uuid>[]

Organizational team UUID to assign (replaces existing assignment for this team). At most one team per person. Send an empty array to clear.

Maximum array length: 1

department_ids

string<uuid>[]

deprecated

Deprecated alias for team_ids. Use team_ids instead.

Maximum array length: 1

job_title

string | null

Job title on the team link.

referent_id

string<uuid>

Team member profile UUID as referent; must belong to the API key's team. Cannot be cleared.

Response

Success

data

object

Show child attributes

curl --request PATCH \
  --url https://api.folkyn.com/api/v1/freelancers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ERP-F-88421",
  "note": "Preferred for Q3 staffing"
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "external_id": "<string>",
    "job_title": "<string>",
    "note": "<string>",
    "referent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>"
    },
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "depth": 2,
        "path": "<string>",
        "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "kyc_complete": true,
    "master_agreement_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "first_name": "<string>",
    "last_name": "<string>"
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

{
  "error": {
    "code": 401,
    "message": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "details": {
      "field": "name",
      "requiredScope": "tags:write",
      "retryAfterSeconds": 1
    }
  }
}

Overview

Specification

Project codes

Team tags

Teams

Missions

Freelancers

Users

Activity reports

Accounting

Update Freelancer Team Fields

Authorizations

Path Parameters

Body

Response