Missions

Update Mission

Updates a mission for the API key’s team.

After a signature has been collected (freelancer or company), or once the mission has moved past pre-signature review, only enterprise fields are accepted: name, purchase_order, external_id, and project code fields.

Before any signature, you may also send contractual fields (description, dates, rate, deliverables, team_signer_id, payment terms). For services agreement missions with a generated contract, Folkyn regenerates the prestation PDF from the updated data (same behaviour as the Folkyn app edit flow).

PATCH

https://api.folkyn.com

api

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",
    "payment_terms_days": 183,
    "payment_terms_basis": "invoice_date",
    "status": "draft",
    "early_termination_date": "2023-12-25",
    "terminated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_referent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "company": "<string>",
      "siren": "<string>",
      "address": "<string>",
      "postal_code": "<string>",
      "city": "<string>"
    },
    "purchase_order": "<string>",
    "external_id": "<string>",
    "project_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_code": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>"
    },
    "project_codes": [
      {
        "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,
        "description": "<string>"
      }
    ],
    "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",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      },
      "is_umbrella": true
    },
    "team_signer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
}

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

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

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

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

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

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

Authorizations

Authorization

string

header

required

Use Authorization: Bearer <your_api_key>

Path Parameters

string<uuid>

required

Body

application/json

At least one field required.

Enterprise fields (always allowed when the mission belongs to your team): name, purchase_order, external_id, project code fields.

Contractual fields (only before any document signature): description, mission_type, rate_amount, start_date, end_date, payment_terms_days, payment_terms_basis, deliverables, team_signer_id. Sending a contractual field after a signature returns 400.

Send only one of project_code_id or project_code when updating the project code (not both in the same request).

description

string

Mission description. Contractual — only before any signature.

mission_type

enum<string>

Contractual — only before any signature.

Available options:

hourly,

daily,

monthly,

deliverable

rate_amount

number

Unit rate (required style for non-deliverable missions). Contractual — only before any signature.

start_date

string<date>

Contractual — only before any signature (YYYY-MM-DD).

end_date

string<date>

Contractual — only before any signature (YYYY-MM-DD).

payment_terms_days

integer

Contractual — only before any signature.

Required range: 1 <= x <= 365

payment_terms_basis

enum<string>

Reference date used to start counting payment delay days. On POST /missions, when omitted, uses the team default from Folkyn settings (Configuration → Missions).

Available options:

invoice_date,

end_of_month

deliverables

any[]

Contractual — only before any signature. For deliverable missions only.

team_signer_id

string<uuid> | null

Company signatory for mission documents. Contractual — only before any signature.

name

string

Mission title.

Maximum string length: 255

purchase_order

string | null

Maximum string length: 255

external_id

string | null

External identifier for the mission (e.g. an ERP or third-party system reference). Send null or "" to clear it.

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_ids

string<uuid>[]

Replace the full list of project codes linked to the mission (requires the team setting for multiple codes). Send an empty array to unlink all codes. Mutually exclusive with project_code_id and project_code.

project_code

object | null

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.

Show child attributes

Response

Success

data

object

Show child attributes

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",
    "payment_terms_days": 183,
    "payment_terms_basis": "invoice_date",
    "status": "draft",
    "early_termination_date": "2023-12-25",
    "terminated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_referent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "company": "<string>",
      "siren": "<string>",
      "address": "<string>",
      "postal_code": "<string>",
      "city": "<string>"
    },
    "purchase_order": "<string>",
    "external_id": "<string>",
    "project_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_code": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>"
    },
    "project_codes": [
      {
        "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,
        "description": "<string>"
      }
    ],
    "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",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      },
      "is_umbrella": true
    },
    "team_signer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
}

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

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

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

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

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

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

Overview

Specification

Project codes

Team tags

Teams

Missions

Freelancers

Users

Activity reports

Accounting

Update Mission

Authorizations

Path Parameters

Body

Response