Meta tags:
description= Create a new segment.;
Headings (most frequently used words):
segments, create, segment, authentication, path, parameters, request, response, errors, list, oauth, scope, read,
Text of the page (most frequently used words):
badge (200), intent (100), minimal (100), outlined (100), oauth (88), scope (87), info (87), read (50), list (44), subscription (43), write (36), #segment (33), subscriptions (32), get (32), create (31), segments (25), the (17), update (17), newsletter (17), post (15), warning (14), beta (14), posts (12), custom (11), publications (10), newsletter_lists (10), field (9), custom_fields (9), 0000 (9), webhooks (9), email (8), token (8), tier (8), input (7), status (7), delete (7), tiers (7), automations (7), from (6), ids (6), endpoint (6), subscribers (6), data (6), api (6), automation (6), use (5), with (5), error (5), object (5), for (5), polls (5), new (4), addresses (4), processed (4), and (4), returns (4), will (4), results (4), emails (4), manual (4), page (4), request (4), name (4), publication (4), bearer (4), identify (4), webhook (4), deletion (4), explicit (3), that (3), filters (3), values (3), available (3), dynamic (3), completed (3), lists (3), required (3), publicationid (3), type (3), 000000000000 (3), 1111 (3), beehiiv (3), data_deletion (3), condition (3), complimentary (3), access (3), bulk (3), resumed (3), paused (3), synchronously (2), net (2), ignored (2), using (2), asynchronously (2), after (2), processing (2), complete (2), pending (2), this (2), requests (2), not (2), created (2), response (2), string (2), authentication (2), authorization (2), sub_00000000 (2), https (2), com (2), curl (2), reference (2), demo (2), start (2), trial (2), login (2), add (2), subscriber (2), recalculate (2), referral (2), program (2), templates (2), url (2), poll (2), engagements (2), fields (2), condition_sets (2), sets (2), complimentary_access (2), updates (2), journeys (2), authors (2), advertisement (2), opportunities (2), oauth2 (2), survey (2), deleted (2), code (2), integrations (2), rate (2), limiting (2), pagination (2), key (2), getting (2), started (2), search (2), documentation (2), index (2), level (2), llms (2), txt (2), any (2), built, next, previous, yes, was, helpful, internal, server, 500, too, many, 429, found, 404, unauthorized, 401, bad, 400, errors, expand, see, show, variants, creation, filtered, unique, does, already, exist, expects, prefixed, format, pub_, path, parameters, form, where, your, auth, 1666800076, last_calculated, true, active, total_results, seg_00000000, 201, try, 111111111111, content, application, json, pub_00000000, copy, light, workspace, tag, referral_program, generate, preview, send, test, aggregate, stats, responses, user, set, journey, author, introspect, revoke, authorize, submitted, added, downgraded, upgraded, confirmed, scheduled, updated, sent, unsubscribed, subscribed, workspaces, tags, del, put, users, tokens, authorizations, welcome, ask, agents, root, append, markdown, version, developer,
Text of the page (random words):
create segment beehiiv developer documentation for ai agents a documentation index is available at the root level at llms txt append llms txt to any url for a page level index or md for the markdown version of any page search ask ai login start trial get a demo search welcome getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription post subscription survey oauth2 authorizations tokens api reference advertisement opportunities authors automation journeys automations bulk subscriptions bulk subscription updates complimentary access condition sets custom fields data deletion engagements newsletter lists newsletter list subscriptions oauth users polls posts post templates publications referral program segments post create segment get list segments badge intent info minimal outlined oauth scope segments read badge get get segment badge intent info minimal outlined oauth scope segments read badge put recalculate segment badge intent info minimal outlined oauth scope segments write badge get list segment subscribers badge intent info minimal outlined oauth scope segments read badge get list segment subscriber ids badge intent info minimal outlined oauth scope segments read badge del delete segment badge intent info minimal outlined oauth scope segments write badge subscriptions subscription tags tiers webhooks workspaces getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription subscribed badge intent warning minimal outlined beta badge newsletter list subscription unsubscribed badge intent warning minimal outlined beta badge newsletter list subscription paused badge intent warning minimal outlined beta badge newsletter list subscription resumed badge intent warning minimal outlined beta badge post sent post updated post scheduled subscription created subscription confirmed subscription deleted subscription upgraded subscription downgraded subscription paused subscription resumed subscription tier paused subscription tier resumed subscription tier added subscription tier deleted survey response submitted oauth2 authorize create token revoke token introspect token get token info get advertisement opportunities badge intent info minimal outlined oauth scope posts read badge list authors get author add subscription to an automation badge intent info minimal outlined oauth scope automations write badge list automation journeys badge intent info minimal outlined oauth scope automations read badge get automation journey badge intent info minimal outlined oauth scope automations read badge list automations badge intent info minimal outlined oauth scope automations read badge get automation badge intent info minimal outlined oauth scope automations read badge list automation emails bulk create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscription updates badge intent info minimal outlined oauth scope subscriptions read badge get subscription update badge intent info minimal outlined oauth scope subscriptions read badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge list complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge get complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge list condition sets badge intent info minimal outlined oauth scope condition_sets read badge get condition set badge intent info minimal outlined oauth scope condition_sets read badge create custom field badge intent info minimal outlined oauth scope custom_fields write badge get custom field badge intent info minimal outlined oauth scope custom_fields read badge list custom fields badge intent info minimal outlined oauth scope custom_fields read badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge delete custom field badge intent info minimal outlined oauth scope custom_fields write badge create data deletion request badge intent info minimal outlined oauth scope data_deletion write badge get data deletion request badge intent info minimal outlined oauth scope data_deletion read badge list data deletion requests badge intent info minimal outlined oauth scope data_deletion read badge get publication engagements badge intent info minimal outlined oauth scope publications read badge list newsletter lists badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge create newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge delete newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge create newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge list newsletter list subscriptions badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge update newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list subscription by subscription id badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge identify user badge intent info minimal outlined oauth scope identify read badge list polls badge intent info minimal outlined oauth scope polls read badge get poll badge intent info minimal outlined oauth scope polls read badge list poll responses badge intent info minimal outlined oauth scope polls read badge create post badge intent info minimal outlined oauth scope posts write badge update post badge intent info minimal outlined oauth scope posts write badge list posts badge intent info minimal outlined oauth scope posts read badge get aggregate stats badge intent info minimal outlined oauth scope posts read badge get post badge intent info minimal outlined oauth scope posts read badge delete post badge intent info minimal outlined oauth scope posts write badge send test email badge intent info minimal outlined oauth scope posts badge generate post preview url badge intent info minimal outlined oauth scope posts read badge get post templates badge intent info minimal outlined oauth scope posts read badge list publications badge intent info minimal outlined oauth scope publications read badge get publication badge intent info minimal outlined oauth scope publications read badge get referral program badge intent info minimal outlined oauth scope referral_program read badge create segment list segments badge intent info minimal outlined oauth scope segments read badge get segment badge intent info minimal outlined oauth scope segments read badge recalculate segment badge intent info minimal outlined oauth scope segments write badge list segment subscribers badge intent info minimal outlined oauth scope segments read badge list segment subscriber ids badge intent info minimal outlined oauth scope segments read badge delete segment badge intent info minimal outlined oauth scope segments write badge create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge delete subscription badge intent info minimal outlined oauth scope subscriptions write badge add subscription tag badge intent info minimal outlined oauth scope subscriptions write badge create a tier badge intent info minimal outlined oauth scope tiers write badge list tiers badge intent info minimal outlined oauth scope tiers read badge get tier badge intent info minimal outlined oauth scope tiers read badge update a tier badge intent info minimal outlined oauth scope tiers write badge update a tier badge intent info minimal outlined oauth scope tiers write badge create a webhook badge intent info minimal outlined oauth scope webhooks write badge list webhooks badge intent info minimal outlined oauth scope webhooks read badge get webhook badge intent info minimal outlined oauth scope webhooks read badge update webhook badge intent info minimal outlined oauth scope webhooks write badge delete a webhook badge intent info minimal outlined oauth scope webhooks write badge identify workspace badge intent info minimal outlined oauth scope identify read badge get publications by subscription email badge intent info minimal outlined oauth scope publications read badge login start trial get a demo light api reference segments create segment copy page post https api beehiiv com v2 publications publicationid segments create from subscription ids create from custom field filters post v2 publications publicationid segments curl curl x post https api beehiiv com v2 publications pub_00000000 0000 0000 0000 000000000000 segments h authorization bearer token h content type application json d name my segment input type subscriptions subscriptions sub_00000000 0000 0000 0000 000000000000 sub_00000000 1111 1111 1111 111111111111 try it 201 create from subscription ids 1 2 data 3 id seg_00000000 0000 0000 0000 000000000000 4 name my segment 5 type manual 6 total_results 2 7 status completed 8 active true 9 last_calculated 1666800076 10 11 create a new segment br br manual segments use subscriptions or emails input to create a segment from an explicit list of subscription ids or email addresses the segment is processed synchronously and returns with status completed net new email addresses will be ignored create subscriptions using the create subscription endpoint br br dynamic segments use custom_fields input to create a segment that filters subscribers by custom field values the segment is processed asynchronously and returns with status pending results will be available in the list segment subscribers endpoint after processing is complete authentication authorization bearer bearer authentication of the form bearer token where token is your auth token path parameters publicationid string required format pub_ 0 9a fa f the prefixed id of the publication object request this endpoint expects an object name string required a unique name for the segment that does not already exist in the publication input object required input for segment creation use subscriptions or emails to create a manual segment from explicit lists or custom_fields to create a dynamic segment filtered by custom field values show 3 variants response created data object the segment object to expand results see the results endpoint errors 400 bad request error 401 unauthorized error 404 not found error 429 too many requests error 500 internal server error was this page helpful yes no previous list segments oauth scope segments read next built with create a new segment manual segments use subscriptions or emails input to create a segment from an explicit list of subscription ids or email addresses the segment is processed synchronously and returns with status completed net new email addresses will be ignored create subscriptions using the create subscription endpoint dynamic segments use custom_fields input to create a segment that filters subscribers by custom field values the segment is processed asynchronously and returns with status pending results will be available in the list segment subscribers endpoint after processing is complete
|
