Interface CreatePersonInput

The CreatePersonInput used by the constructor of CreatePerson

interface CreatePersonInput {
    email?: string;
    firstName?: string;
    lastName?: string;
    metadata?: {
        [key: string]: string;
    };
    personId?: string;
    phone?: string;
}

Properties

email?: string

email on the person.

firstName?: string

first name on the person.

lastName?: string

last name on the person.

metadata?: {
    [key: string]: string;
}

any additional metadata attributes required by the person.

Type declaration

  • [key: string]: string
personId?: string

Existing person id if updating a customer record

phone?: string

phone number on the person, should start with +{country code}