Built LMS Help Center
MCP ServerTool Reference

Set User Custom Fields

Set User Custom Fields MCP tool.

Set User Custom Fields

Set one user's custom field values by field_key, validated against field definitions (multiselect is a string array); an unknown key or invalid value fails the whole call. Unnamed fields are kept; null clears one. Returns every stored value.

Contract

FieldValue
Tool nameset_user_custom_fields
Domainusers
Required scopespeople:write
TitleSet user custom fields
Read only hintfalse
Destructive hintfalse
Idempotent hinttrue
Open world hintfalse
Bulk limitnone
Timeout10000ms
Kill switch keyusers.custom_fields.set
REST siblingPUT /api/public/v1/users/{id}/custom-fields

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "custom_fields": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9._:-]+$"
    }
  },
  "required": [
    "id",
    "custom_fields",
    "idempotency_key"
  ],
  "additionalProperties": false
}

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "const": "text"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "text"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "content"
  ],
  "additionalProperties": false
}

On this page