Skip to navigation
API Referencesegments

Snapshot a Segment

Start a snapshot of the members of a segment. The API makes the snapshot in the background. Use Get Segment Snapshot to see its status. To snapshot an advanced segment, the account's plan must include advanced segmentation. If it does not, the API returns a 403 error. Other types of segment do not need advanced segmentation.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

segment_idstringRequired
The unique id for the segment.

Response

The snapshot request that the API accepted.
idstringOptionalRead-only
The unique ID of the snapshot.
statusenumOptionalRead-only
The status of the snapshot.
Allowed values: