Contacts & events

email_create_segment

Create a named segment from a filter over contact attributes ⊕ tags (paths like 'contact.attributes.plan' or bare attribute keys; ops eq/neq/exists/not_exists/in/gt/lt/contains).

write email_create_segment

Create a named segment from a filter over contact attributes ⊕ tags (paths like 'contact.attributes.plan' or bare attribute keys; ops eq/neq/exists/not_exists/in/gt/lt/contains). Member count is primed on create. Use the segment id as an automation trigger via email_create_automation's triggerSegmentId.

Parameters

ParameterTypeRequiredDescription
namestringYes
descriptionstringNo
filterobject[]Yes
projectIdstringNoTarget company (project id) — required on project-scoped tools. Call email_list_projects to enumerate companies.

On this page