List data model

Updated:

Mailing List

FieldTypeRequiredDescription
idstringNoIdentifier for this list
created_atstring (date-time)NoDate that this list was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe list's name
descriptionstringNo
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNoThe user who created this list (reference to HrisEmployee)
is_activebooleanNo
addressobjectNo
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNo
subjectstringNo
sender_namestringNo
sender_emailstringNo
languagestringNo
sender_companystringNo
sender_phonestringNo
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 MarketingList = {
	id?: string; // Identifier for this list
	created_at?: string-time; // Date that this list was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The list's name
	description?: string;
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	user_id?: string; // The user who created this list (reference to HrisEmployee)
	is_active?: boolean;
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; 
	};
	subject?: string;
	sender_name?: string;
	sender_email?: string;
	language?: string;
	sender_company?: string;
	sender_phone?: string;
	metadata?: [];
	raw?: any; // The raw data returned by the integration for this list
} 

Zod

Zod
import { z } from 'zod';

export const ZodMarketingList = z.object({
	id: z.string().optional().describe("Identifier for this list"),
	created_at: z.string-time().optional().describe("Date that this list was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The list's name"),
	description: z.string().optional(),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	user_id: z.string().optional().describe("The user who created this list (reference to HrisEmployee)"),
	is_active: z.boolean().optional(),
	address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			region_code: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional()
}).optional(),
	subject: z.string().optional(),
	sender_name: z.string().optional(),
	sender_email: z.string().optional(),
	language: z.string().optional(),
	sender_company: z.string().optional(),
	sender_phone: z.string().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyMarketingListAddress:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	country_code: Optional[str]

@dataclasses.dataclass
class MarketingList:
	"""Identifier for this list"""
	id: Optional[str]
	"""Date that this list was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The list's name"""
	name: Optional[str]
	description: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""The user who created this list (reference to HrisEmployee)"""
	user_id: Optional[str]
	is_active: Optional[bool]
	address: Optional[PropertyMarketingListAddress]
	subject: Optional[str]
	sender_name: Optional[str]
	sender_email: Optional[str]
	language: Optional[str]
	sender_company: Optional[str]
	sender_phone: Optional[str]
	metadata: Optional[PropertyMarketingListMetadata]
Are we missing anything? Let us know
Was this page helpful?