Skip to main content
PATCH
https://api.folkyn.com
/
api
/
v1
/
missions
/
{id}
curl --request PATCH \
  --url https://api.folkyn.com/api/v1/missions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_code": {
    "name": "ACME — renewal 2026",
    "external_id": "ERP-PROJ-88421"
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "mission_type": "hourly",
    "contract_kind": "master_agreement",
    "has_document": true,
    "currency": "EUR",
    "rate_amount": 123,
    "client_rate_amount": 123,
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "display_status": "draft",
    "external_referent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "company": "<string>",
      "siren": "<string>",
      "address": "<string>",
      "postal_code": "<string>",
      "city": "<string>"
    },
    "purchase_order": "<string>",
    "project_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_code": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>"
    },
    "deliverables_catalog": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "quantity": 123,
        "amount_excl_vat": 123,
        "order_index": 123
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "freelancer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "referent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      }
    },
    "team_signer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://doc.folkyn.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <your_api_key>

Path Parameters

​
id
string<uuid>
required

Body

application/json

At least one field required. Same rules as the Folkyn app enterprise PATCH after signature. Send only one of project_code_id or project_code when updating the project code (not both in the same request).

​
name
string

Mission title.

Maximum string length: 255
​
purchase_order
string | null
Maximum string length: 255
​
project_code_id
string<uuid> | null

Link the mission to an existing team project code by UUID (the row must belong to the same team as the API key). Send null or "" to unlink the mission from any project code. Mutually exclusive with project_code in the same request.

​
project_code
object

Create or reuse a team project code and link the mission in one request. Send null to unlink. Mutually exclusive with project_code_id. Field-level rules are on name and external_id below.

Response

Success

​
data
object