latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

Users

Update a BadgeUser

patch/v2/users/{idOrEntityId}

Path parameters

idOrEntityIdstring required

Request body

firstNamestring

lastNamestring

marketingOptInboolean

Example request

{
  "firstName": "Jane",
  "lastName": "Doe",
  "marketingOptIn": true
}

Response

errorCodestring nullable

fieldErrorsobject required

latestTermsVersioninteger nullable

nonFieldErrorsstring[] required

timestampstring date-time nullable

validationErrorsstring[] required

warningsobject required

Example response

{
  "result": [
    {
      "agreedTermsVersion": 4,
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "emails": [
        {
          "email": "Jane.Doe@example.com"
        }
      ],
      "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
      "entityType": "BadgeUser",
      "firstName": "Jane",
      "id": "5f16c84d1ff787222b6c4d15",
      "lastName": "Doe",
      "marketingOptIn": true,
      "recipient": {
        "identity": "jane.doe@example.com"
      }
    }
  ],
  "status": {
    "description": "ok"
  }
}