/1/ Learner - PATCH

Overview

The /1/learner endpoint provides for the creation of new users.

Beta API

NOTE: This API is currently in beta and applies only to the 'iFrame' API customers.

KeyValueExample
User-Agent<company identifier>The exact value here is not important, but it should include something to identify your company
Acceptapplication/json
AuthorizationBearer <your token>Bearer wV1MLkss5+sFzioJw/3M5r9A==
(Optional) User IDX-UserId: IDThis will attach the Learner to this User (so if you have a User who want's to create a Learner under his account/org you would add their userid. This relationship is meant to be permanent however we do have the /1/learner/X/transfer call for you.

Code Example

  curl --location --request PATCH 'https://api-sandbox.vbmappapp.com/1/learner/34444' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer XXXXXXXXXX' \
  --data '{
      "firstName": "John",
      "lastName": "Doe",
      "code": "JD123"
  }'

Example Response

  {
      "id": 232323,
      "code": "JD123",
      "dateOfBirth": "2025-10-02",
      "firstName": "John",
      "lastName": "Doe",
      "gender": 1,
      "isActive": 1,
      "createdAt": "2025-10-27 19:13:03",
      "updatedAt": "2025-11-12 22:36:59"
  }

Did this page help you?