Member data model

Updated:

A member represents a person

FieldTypeRequiredDescription
idstringNoUnique identifier for this member object
created_atstring (date-time)NoThe date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the member
first_namestringNo
last_namestringNo
companystringNoThe name of the company/organization the member belongs to
emailsMarketingEmail[]NoAn array of email addresses for this member
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
list_idsstring[]NoAn array of list IDs associated with this member
tagsstring[]NoAn array of tags associated with this member
statusenumNoValues: SUBSCRIBED, UNSUBSCRIBED, CLEANED, PENDING, TRANSACTIONAL
metadataMarketingMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type MarketingMember = {
	id?: string; // Unique identifier for this member object
	created_at?: string-time; // The date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the member
	first_name?: string;
	last_name?: string;
	company?: string; // The name of the company/organization the member belongs to
	emails?: []; // An array of email addresses for this member
	list_ids?: string[]; // An array of list IDs associated with this member
	tags?: string[]; // An array of tags associated with this member
	status?: 'SUBSCRIBED' | 'UNSUBSCRIBED' | 'CLEANED' | 'PENDING' | 'TRANSACTIONAL';
	metadata?: [];
	raw?: any; // The raw data returned by the integration for this member
} 

Zod

Zod
import { z } from 'zod';

export const ZodMarketingMember = z.object({
	id: z.string().optional().describe("Unique identifier for this member object"),
	created_at: z.string-time().optional().describe("The date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the member"),
	first_name: z.string().optional(),
	last_name: z.string().optional(),
	company: z.string().optional().describe("The name of the company/organization the member belongs to"),
	emails: z.array().optional().describe("An array of email addresses for this member"),
	list_ids: z.array().optional().describe("An array of list IDs associated with this member"),
	tags: z.array().optional().describe("An array of tags associated with this member"),
	status: z.enum("SUBSCRIBED", "UNSUBSCRIBED", "CLEANED", "PENDING", "TRANSACTIONAL").optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class MarketingMemberStatus(str, Enum):
	SUBSCRIBED = 'SUBSCRIBED'
	UNSUBSCRIBED = 'UNSUBSCRIBED'
	CLEANED = 'CLEANED'
	PENDING = 'PENDING'
	TRANSACTIONAL = 'TRANSACTIONAL'

@dataclasses.dataclass
class MarketingMember:
	"""Unique identifier for this member object"""
	id: Optional[str]
	"""The date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the member"""
	name: Optional[str]
	first_name: Optional[str]
	last_name: Optional[str]
	"""The name of the company/organization the member belongs to"""
	company: Optional[str]
	"""An array of email addresses for this member"""
	emails: Optional[PropertyMarketingMemberEmails]
	"""An array of list IDs associated with this member"""
	list_ids: Optional[List[List[str]]]
	"""An array of tags associated with this member"""
	tags: Optional[List[List[str]]]
	status: Optional[MarketingMemberStatus]
	metadata: Optional[PropertyMarketingMemberMetadata]
Are we missing anything? Let us know
Was this page helpful?