API Reference

Update segment

PATCH /segments/:id — edit a segment’s name or filter.

PATCH/segments/:id

Body parameters

namestringoptional

New name.

filter.statusstringoptional

New status filter: all, subscribed, or unsubscribed.

filter.email_containsstring | nulloptional

New email substring (pass null to clear).

filter.property_filtersarray | nulloptional

Replace the property-filter list (pass null or [] to clear). Each entry: { key, operator, value? }. Keys must be registered via POST /contact-properties.

A segment’s domain cannot be changed — passing domain (or audience_id) here is rejected.

import { MailBlastr } from 'mailblastr';

const mb = new MailBlastr('mb_xxxxxxxxx');

const { data, error } = await mb.segments.update('seg_9a2f...', { "filter": { "status": "all" } });
console.log({ data, error });