Update GP worker additional information | Deel

Use this endpoint to correct or change country-specific additional information already held on a Global Payroll worker contract, for example after the worker reports a new marital status or a tax identifier changes. Only the fields sent under data are modified; everything else is left untouched. Field keys must belong to the additional-information fields defined for the contract country (see GET /rest/forms/gp/worker-additional-fields/{country_code}). For fields the organization has configured as effective-dated, a date must be supplied in effective_dates (YYYY-MM-DD) whenever the value changes: today or a past date applies the change immediately, a future date schedules it and the current value stays in effect until then. Unchanged values and clears need no date. Changes are recorded in the contract history and may update the worker onboarding checklist. By default returns 204. Pass ?include_completion_status=true to receive a 200 response with is_additional_data_done (true when all required fields for EDM onboarding are provided) and missing_keys (required fields still absent). Requires the people:write scope.

Token scopes: people:write

Use this endpoint to correct or change country-specific additional information already held on a Global Payroll worker contract, for example after the worker reports a new marital status or a tax identifier changes. Only the fields sent under `data` are modified; everything else is left untouched. Field keys must belong to the additional-information fields defined for the contract country (see `GET /rest/forms/gp/worker-additional-fields/{country_code}`). For fields the organization has configured as effective-dated, a date must be supplied in `effective_dates` (`YYYY-MM-DD`) whenever the value changes: today or a past date applies the change immediately, a future date schedules it and the current value stays in effect until then. Unchanged values and clears need no date. Changes are recorded in the contract history and may update the worker onboarding checklist. By default returns 204. Pass `?include_completion_status=true` to receive a 200 response with `is_additional_data_done` (true when all required fields for EDM onboarding are provided) and `missing_keys` (required fields still absent). Requires the `people:write` scope. **Token scopes**: `people:write`

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

The unique public identifier of the contract.

Query parameters

include_completion_statusbooleanOptional

Pass true to receive a 200 response with is_additional_data_done and missing_keys instead of the default 204 No Content.

Request

This endpoint expects an object.

datamap from strings to strings or doubles or booleansRequired

effective_datesmap from strings to stringsOptional

Per-field effective date (YYYY-MM-DD), keyed like data. Only allowed for effective-dated fields, and required whenever such a field is set to a new value (unchanged values and clears need no date). Past dates apply immediately as corrections, future dates are scheduled.

Response

Returned only when ?include_completion_status=true is passed. Contains completion status.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Token scopes: people:write