Archive Custom Segment

Archives an existing custom segment (File or Filter). Archiving and unarchiving through APIs makes it easy to retrieve and reuse custom segments whenever required for purposes such as A/B testing, maintaining regulatory compliance, and improving system performance. You can access the archived segments and utilize them to analyze and market campaigns without the need to recreate them from scratch.

PATCH /v2/custom-segments/archive

Archive Custom Segment

cURL

curl --request PATCH \
  --url https://api-{dc}.moengage.com/v2/custom-segments/archive \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "custom_segment_unique_name"
}
'

202

{
  "message": "Successfully archived the custom segment",
  "success": true,
  "cs_name": "custom_segment_unique_name"
}

Archived segments will not be shown beyond 180 days.

Authorizations

Authorization · string · header · required

Basic Authentication using your Workspace ID (as username) and Data API Key (as password) from the MoEngage Dashboard.

Body

application/json

The name of the custom segment to be archived.

Schema for requests that only require the segment name.

name · string · required

The name of the custom segment.

Response

202

application/json

Custom-segment archive request accepted.

message · string

The status message of the request.

success · boolean

Indicates if the request was accepted.

Example:

true

cs_name · string

The unique name of the custom segment being processed.