Create Subject

client.subjects.create(, ?): SubjectCreateResponse { id, created_at, email, 3 more }

post/subjects

Create Subject

ParametersExpand Collapse

body: SubjectCreateParams { email, external_id, metadata, name }

email?: string | null

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

formatemail

external_id?: string | null

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?: Record<string, string>

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

name?: string | null

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

ReturnsExpand Collapse

SubjectCreateResponse { 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 | null

The email of the subject.

formatemail

external_id: string | null

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

metadata: Record<string, string>

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

name: string | null

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

Create Subject

import Lark from 'lark-billing';

const client = new Lark({
  apiKey: 'My API Key',
});

const subject = await client.subjects.create({
  email: 'john.doe@example.com',
  external_id: 'user_1234567890',
  metadata: {},
  name: 'John Doe',
});

console.log(subject.id);

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