HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Create Campaign Recipient Estimation Job

Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the Get Campaign Recipient Estimation Job endpoint to retrieve the status of this estimation job. Use the Get Campaign Recipient Estimation endpoint to retrieve the estimated recipient count for a given campaign.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
campaigns:write

Body Params

Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the Get Campaign Recipient Estimation Job endpoint to retrieve the status of this estimation job. Use the Get Campaign Recipient Estimation endpoint to retrieve the estimated recipient count for a given campaign.

object
required
string
required
object
required
string
required

The ID of the campaign to perform recipient estimation

Headers
string
required
Defaults to 2023-06-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials