Update Subject

put/subjects/{subject_id}

Update Subject

Path ParametersExpand Collapse

subject_id: string

Body ParametersExpand Collapse

email: string

The email of the subject. Must be a valid email address.

formatemail

metadata: map[string]

Additional metadata about the subject. You may use this to store any custom data about the subject.

name: string

The name of the subject. Used for display in the dashboard.

ReturnsExpand Collapse

SubjectResource = object { id, created_at, email, 3 more }

id: string

The ID of the subject.

created_at: string

The date and time the subject was created.

formatdate-time

email: string

The email of the subject.

formatemail

external_id: string

The ID of the subject in your system. You may pass it to the API in place of the subject ID.

metadata: map[string]

Additional metadata about the subject. You may use this to store any custom data about the subject.

name: string

The name of the subject. Used for display in the dashboard.

Update Subject

curl https://api.uselark.ai/subjects/$SUBJECT_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $LARK_API_KEY" \
    -d '{
          "email": "john.doe@example.com",
          "metadata": {},
          "name": "John Doe"
        }'

{
  "id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
  "created_at": "2025-11-01T00:00:00Z",
  "email": "john.doe@example.com",
  "external_id": "user_1234567890",
  "metadata": {},
  "name": "John Doe"
}

Returns Examples

{
  "id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
  "created_at": "2025-11-01T00:00:00Z",
  "email": "john.doe@example.com",
  "external_id": "user_1234567890",
  "metadata": {},
  "name": "John Doe"
}