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.

post/3.0/segments/{segment_id}/snapshots

Request

Base URL
https://api.mailchimp.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://login.mailchimp.com/oauth2/authorize
  Token URLhttps://login.mailchimp.com/oauth2/token
TypeScript
https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/segments/:segment_id/snapshots/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

segment_idstring required

The unique id for the segment.

Response

The snapshot request that the API accepted.

idstring

The unique ID of the snapshot.

status'pending' | 'running' | 'completed' | 'failed' | 'canceled'

The status of the snapshot.

Example response

{
  "id": "b1b49562-5a44-4ebd-822c-5e215f66f679",
  "status": "pending"
}

Changes

No recorded changes to this operation across all 1 revision of this API.