> ## Documentation Index
> Fetch the complete documentation index at: https://moengage.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Archive Segment
> This API archives an existing segment (File or Filter). Archiving and unarchiving through APIs makes it easy to retrieve and reuse 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.
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.
## OpenAPI
````yaml /api/custom-segments/custom-segments.yaml patch /v2/custom-segments/archive
openapi: 3.0.3
info:
title: MoEngage Segments API
description: >
Use the MoEngage Segments API to create, update, and manage your file and
filter segments.
- **v2 API:** Manage File Segments and segment lifecycle
(Archive/Unarchive).
- **v3 API:** Create, read, update, and list filter-based Segments.
version: '3.0'
servers:
- url: https://api-{dc}.moengage.com
description: MoEngage API Endpoint
variables:
dc:
description: >-
The ‘dc’ in the API Endpoint URL refers to the MoEngage Data Center
(DC). MoEngage hosts each customer in a different DC. You can find
your DC number and replace the value of ‘dc’ in the URL by referring
to the DC and API endpoint mapping
[here](/api/introduction#data-centers). Your MoEngage Data Center (DC)
can be 01, 02, 03, 04, 05, 06, or 101.
default: '01'
security:
- basicAuth: []
tags:
- name: File Segments
description: >
If you need to create segments by importing a large number of users, we
recommend utilising the File segment API. This API allows you to easily
generate a file segment by initiating a call to the file segment API
endpoint. To proceed, you will need to compile a CSV file containing the
relevant users (ensuring that the users are already present in MoEngage).
It is essential to provide the public path of the file, which allows for
downloading and identification of users in order to successfully create
the file segment.
Use the File Segment API to:
* Create a new file segment
* Add users to an existing segment
* Remove users from an existing segment
* Replace users from an existing segment
- name: Manage Segments
description: >
Archiving and unarchiving through APIs makes it easy to retrieve and reuse
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.
x-mint:
content: |
Archived segments will not be shown beyond 180 days.
- name: Filter Segments
description: >
If you need to create a segment based on the events or actions performed
by your users on your application or website, the recommended approach is
to use the filter segment API. With this API, you can create a segment by
specifying the desired filter conditions.
The filter segment API supports various operations, including create,
update, get, and list, allowing you to effectively manage your segments
based on specific criteria.
x-mint:
content: >
## Authentication
Authentication is performed using Basic Auth. You must also provide the
`MOE-APPKEY` header.
## Request Headers
| Key | Required | Description |
| :--- | :--- | :--- |
| `Content-Type` | Yes | Set to `application/json`. |
| `Authorization` | Yes | Basic Auth. `{"Authorization": "Basic
Base64_ENCODED_WORKSPACEID_APIKEY="}` |
| `MOE-APPKEY` | Yes | Your MoEngage App ID. Found in Settings ->
Account -> APIs -> App ID. |
paths:
/v2/custom-segments/archive:
patch:
tags:
- Manage Segments
summary: Archive Segment
description: >-
This API archives an existing segment (File or Filter). Archiving and
unarchiving through APIs makes it easy to retrieve and reuse 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.
operationId: archiveCustomSegment
requestBody:
description: The name of the segment to be archived.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentNameRequestV2'
example:
name: custom_segment_unique_name
cs_id:
responses:
'202':
description: Segment archive request accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseSuccessV2'
example:
message: Successfully archived the custom segment
success: true
cs_name: custom_segment_unique_name
cs_id:
'400':
$ref: '#/components/responses/400_FileSegmentError'
'401':
$ref: '#/components/responses/401_FileSegmentError'
'404':
$ref: '#/components/responses/404_FileSegmentNotFound'
'500':
$ref: '#/components/responses/5XX_FileSegmentError'
components:
schemas:
SegmentNameRequestV2:
description: Schema for requests that only require the segment name.
type: object
properties:
name:
type: string
description: The name of the segment.
cs_id:
type: string
description: >
Unique identifier corresponding to the target segment. When both
`cs_id` and `name` are populated, the system prioritizes `cs_id`.
required:
- name
ApiResponseSuccessV2:
type: object
properties:
message:
type: string
description: The status message of the request.
success:
type: boolean
example: true
description: Indicates if the request was accepted.
cs_name:
type: string
description: The unique name of the segment being processed.
cs_id:
type: string
description: The unique identifier of the segment.
ApiErrorV2:
type: object
properties:
title:
type: string
description: A short title for the error.
description:
type: string
description: A detailed, human-readable explanation of the error.
responses:
400_FileSegmentError:
description: Bad Request. Invalid payload format.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorV2'
example:
title: Invalid Request
description:
401_FileSegmentError:
description: Unauthorized. Authentication or Authorization Failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorV2'
example:
title: Authentication required
description:
404_FileSegmentNotFound:
description: Entity Not Found. The segment name does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorV2'
example:
title: Entity Not Found
description: >-
Segment not found with the given name:
5XX_FileSegmentError:
description: Server Errors. Something went wrong on MoEngage.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorV2'
example:
title: Internal Server Error
securitySchemes:
basicAuth:
type: http
scheme: basic
description: >
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](https://www.moengage.com/docs/api/introduction#getting-your-credentials).
````