API Reference

Subjects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Subject

post/subjects

Create Subject

Body ParametersExpand Collapse

email: optional string

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

formatemail

external_id: optional string

The ID of the subject in your system. If provided, you may use pass it to the API in place of the subject ID. Must be unique.

metadata: optional map[string]

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

name: optional string

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

ReturnsExpand Collapse

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.

Create Subject

HTTP

HTTP

TypeScript

Python

Go

Terraform

curl https://api.uselark.ai/subjects \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $LARK_API_KEY" \
    -d '{}'

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