Contact

Edit a contact

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

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PUT URL.

Edit the details of a contact

put/v2/providers/employers/employees/contacts/{contactId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/contacts/{contactId}
  • Auth
    none required

Path parameters

contactIdstring uuid required

The unique identifier of the employee contact detail

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)

namestring

Name of the contact

descriptionstring

Describes the relationship of the contact to the employee

phoneNumberstring nullable

The phone number of the contact

particularitiesstring nullable

Extra information about the contact

emailAddressstring nullable

The email address of the contact

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "name": "Johanna Bakker",
  "description": "Moeder",
  "phoneNumber": "013-12345678",
  "address": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "postalCode": "1234 AA",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    }
  },
  "particularities": "Genoemd adres is een priveadres",
  "emailAddress": "johanna.bakker@example.com"
}

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",
    "name": "Johanna Bakker",
    "description": "Moeder",
    "phoneNumber": "013-12345678",
    "address": {
      "street": "Voordijk",
      "city": "Leiden",
      "houseNumber": 12,
      "houseNumberAddition": "D",
      "postalCode": "1234 AA",
      "country": {
        "key": 1,
        "value": "Netherlands",
        "isoCode": "NL"
      }
    },
    "particularities": "Genoemd adres is een priveadres",
    "emailAddress": "johanna.bakker@example.com"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.