Workflow employee

Initiate the change contact information workflow for an employee

Activity name: <a href="https://developer.loket.nl/Activities/PostInitiateChangeContactInformationWorkflowByEmployeeId" target="_blank">PostInitiateChangeContactInformationWorkflowByEmployeeId</a><br> <br><br>Allows the user to trigger a workflow to change the contact information for an employee. The workflow may require the change to be approved.<br><br>Metadata : none<br><br>Defaults : none<br>

post/v2/providers/employers/employees/{employeeId}/workflow/InitiateChangeContactInformation

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/{employeeId}/workflow/InitiateChangeContactInformation
  • Auth
    none required

Path parameters

employeeIdstring uuid required

The unique identifier of the employee

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

phoneNumberstring nullable

The phone number of the employee.

mobilePhoneNumberstring nullable

The mobile phone number of the employee.

emailAddressstring nullable

The e-mail address of the employee. Only one email address is allowed.

commentstring nullable

An extra comment for the change request

Example request

{
  "phoneNumber": "+31 13-1234567",
  "mobilePhoneNumber": "+31 6-1231456",
  "emailAddress": "info@loket.nl",
  "comment": "We move house September 26th"
}

Response

Accepted

contentobject

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "BrokenBusinessRule",
      "description": "Invalid value for <field>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ]
}

Changes

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