HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

getMaxRecipients

Queries the value of the Maximum number of recipients option in Optimizely Campaign.

Type: float

Parameters

NameTypeValue
sessionIdStringID of the session
mailingIdlongID of the mailing

Return values

Number of recipients or the percentage of recipients that will receive the mailing after it has been started

The percentage is returned as a float from 0 to 1 (1 meaning 100%, see also: isMaxRecipientsPercentage. The return value -1 means All. See also setMaxRecipients.

Code structure

float getMaxRecipients(String sessionId, long mailingId)

What’s Next
Did this page help you?