Custom field

Edit a custom field record

Changed on

Activity name : <a href="https://developer.loket.nl/Activities/PutCustomFieldByCustomFieldId" target="_blank">PutCustomFieldByCustomFieldId</a>

put/v2/providers/employers/customfields/{customFieldId}

Request

  • Base URL
    https://api.loket.nl
  • Auth
    none required

Path parameters

customFieldIdstring uuid required

The unique identifier of the record

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

descriptionstring

The description for the custom field which can be used at the employee and employment level

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "description": "Shoe size"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "description": "Shoe size"
  }
}

Changes

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      endpoint added