API Reference

Subjects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update Subject

subjects.update(strsubject_id, SubjectUpdateParams**kwargs) -> SubjectResource

put/subjects/{subject_id}

Update Subject

ParametersExpand Collapse

subject_id: str

email: Optional[str]

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

formatemail

metadata: Optional[Dict[str, str]]

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

name: Optional[str]

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

ReturnsExpand Collapse

class SubjectResource: …

id: str

The ID of the subject.

created_at: datetime

The date and time the subject was created.

formatdate-time

email: Optional[str]

The email of the subject.

formatemail

external_id: Optional[str]

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

metadata: Dict[str, str]

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

name: Optional[str]

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

Update Subject

Python

HTTP

TypeScript

Python

Go

Terraform

from lark import Lark

client = Lark(
    api_key="My API Key",
)
subject_resource = client.subjects.update(
    subject_id="subject_id",
    email="john.doe@example.com",
    metadata={},
    name="John Doe",
)
print(subject_resource.id)

200 example

{
  "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

200 example

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