Create a segment

post

https://{buzz_key}.api.beeswax.com/rest/v2/segments

Creates a new segment with the provided attributes. Segments represent user audiences and can be associated with one or more segment categories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_id

integer

required

Defaults to the account in the active session

advertiser_id

integer | null

The advertiser that owns the segment, if any.

name

string

required

length ≤ 255

^[\w[('-]

The name of the segment

description

string | null

The description of the segment

cpm_cost

string | null

^-?\d{0,2}(?:\.\d{0,3})?$

The CPM cost to target this segment.

verb

string

enum

Defaults to ALL

Restricted way segment can be applied to a targeting expression.

ALL - All
INCLUDE - Include
EXCLUDE - Exclude
REQUIRE - Require

Allowed:

ttl_days

integer

0 to 90

How long a user stays in the segment, in days (0-90). Defaults to the account's DEFAULT_SEGMENT_TTL_DAYS setting, or 30 if that is unset.

extensible

boolean

Defaults to true

Whether the segment extends across devices.

aggregate_excludes

boolean

Defaults to false

category_keys

array of strings

required

Keys of the segment categories this segment belongs to, e.g. 'mybuzzkey-1234'. Pass an empty list for an uncategorized segment.

category_keys*

active

boolean

Defaults to true

Whether the segment is active.

alternative_id

string | null

An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.

notes

string | null

Free-form notes of up to 255 characters.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Validation error or invalid parameters.

401

Authentication credentials were not provided.

403

Permission denied.

201Segment created successfully.