Declared in CSAPI+Segments.h

Overview

Segment-related APIs. See CSAPI for documentation of the other API categories.

Tasks

Instance Methods

addRuleToSegmentWithID:rule:completionHandler:errorHandler:

Add a new rule to an existing segment

- (void)addRuleToSegmentWithID:(NSString *)segmentID rule:(CSSegmentRule *)rule completionHandler:(void ( ^ ) ( void ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

segmentID

ID of the segment to which the rule will be added

rule

Rule to add

completionHandler

Completion callback

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#adding_a_segment_rule

Declared In

CSAPI+Segments.h

createSegmentWithListID:title:rules:completionHandler:errorHandler:

Create a new segment for a specific list.

- (void)createSegmentWithListID:(NSString *)listID title:(NSString *)title rules:(NSArray *)rules completionHandler:(void ( ^ ) ( NSString *segmentID ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

listID

ID of the list on which the segment should be created

title

Title of the new segment

rules

An array of CSSegmentRule (or nil)

completionHandler

Completion callback, with the ID of the newly created segment as the first and only argument

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#creating_a_segment

Declared In

CSAPI+Segments.h

deleteSegmentWithID:completionHandler:errorHandler:

Delete an existing segment from a subscriber list.

- (void)deleteSegmentWithID:(NSString *)segmentID completionHandler:(void ( ^ ) ( void ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

segmentID

ID of the segment to be deleted

completionHandler

Completion callback

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#deleting_a_segment

Declared In

CSAPI+Segments.h

getActiveSubscribersWithSegmentID:date:page:pageSize:orderField:ascending:completionHandler:errorHandler:

Get a paged result representing all of the active subscribers that match the rules for a specific segment.

- (void)getActiveSubscribersWithSegmentID:(NSString *)segmentID date:(NSDate *)date page:(NSUInteger)page pageSize:(NSUInteger)pageSize orderField:(NSString *)orderField ascending:(BOOL)ascending completionHandler:(void ( ^ ) ( CSPaginatedResult *))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

segmentID

ID of the segment you want the active subscribers for

date

Subscribers which became active on or after the date specified will be returned

page

The page to retrieve

pageSize

The number of subscribers to retrieve per page. Values accepted are between 10 and 1000.

orderField

The subscriber field to order the list by. Values accepted are email, name or date.

ascending

Whether to sort the list (see orderField) in ascending order

completionHandler

Completion callback, with a CSPaginatedResult as the first and only argument. Items in the result list are CSSubscriber.

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#getting_active_subscribers

Declared In

CSAPI+Segments.h

getSegmentDetailsWithSegmentID:completionHandler:errorHandler:

Get the name, list ID, segment ID, number of active subscribers and rules for a segment.

- (void)getSegmentDetailsWithSegmentID:(NSString *)segmentID completionHandler:(void ( ^ ) ( CSSegment *segment ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

segmentID

ID of the segment to be retrieved

completionHandler

Completion callback, with a CSSegment object as the first and only argument

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#getting_a_segments_details

Declared In

CSAPI+Segments.h

removeAllRulesFromSegmentWithID:completionHandler:errorHandler:

Remove all rules from an existing segment.

- (void)removeAllRulesFromSegmentWithID:(NSString *)segmentID completionHandler:(void ( ^ ) ( void ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

segmentID

ID of the segment whose rules are to be deleted

completionHandler

Completion callback

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#deleting_a_segments_rules

Declared In

CSAPI+Segments.h

updateSegmentWithSegmentID:title:rules:completionHandler:errorHandler:

Update an existing segment.

- (void)updateSegmentWithSegmentID:(NSString *)segmentID title:(NSString *)title rules:(NSArray *)rules completionHandler:(void ( ^ ) ( void ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler

Parameters

segmentID

ID of the segment to be updated

title

Title of the segment

rules

An array of CSSegmentRule (or nil). Existing rules will be removed.

completionHandler

Completion callback

errorHandler

Error callback

Discussion

http://www.campaignmonitor.com/api/segments/#updating_a_segment

Declared In

CSAPI+Segments.h