Skip to main content
PATCH
/
v2
/
custom-segments
/
archive
Archive Segment
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",
  "cs_id": "<unique cs id>"
}
'
{
  "message": "Successfully archived the custom segment",
  "success": true,
  "cs_name": "custom_segment_unique_name",
  "cs_id": "<unique cs id>"
}
Archived segments will not be shown beyond 180 days.
This API endpoint does not currently support Team-level scoping. All segments generated using this call will be assigned to the Default Team automatically.

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Data tile.

For more information on authentication and getting your credentials, refer here.

Body

application/json

The name of the segment to be archived.

Schema for requests that only require the segment name.

​
name
string
required

The name of the segment.

​
cs_id
string

Unique identifier corresponding to the target segment. When both cs_id and name are populated, the system prioritizes cs_id.

Response

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 segment being processed.

​
cs_id
string

The unique identifier of the segment.