If this API is not enabled for your account, contact your MoEngage Customer Success Manager (CSM) or the Support team to request enablement.
Endpoints
The Cards API is a collection of the following endpoints:- Fetch Cards: Retrieves all active and updated cards for a specific user, supporting filtering and pagination.
- Delete Cards: Deletes specific card campaigns for a user from the MoEngage Cards database.
FAQs
Fetch Cards
How do I fetch only the cards updated since the last sync?
How do I fetch only the cards updated since the last sync?
You can use the
prev_sync_card_ids (list of card IDs from the previous sync) and last_updated_time (Unix epoch timestamp of the last sync) fields in the request body. The API will return only the new or updated cards.Can I filter cards by platform or category?
Can I filter cards by platform or category?
Yes. You can filter by platform using the
platforms array (e.g., ["ANDROID", "WEB"]) and by category using the card_category string field in the request body.Which identifier should I use for the user?
Which identifier should I use for the user?
You must provide either the
uid (MoEngage Standard ID like Email or Mobile Number) or the unique_id (Platform-specific device identifier). One of these is required.What is the difference between unique_id and uid?
What is the difference between unique_id and uid?
The unique_id is the unique value that identifies the user to whom the cards need to be shown. It is a platform-specific device identifier that can be generated.The uid is the unique MoEngage Standard ID (Email ID Standard or the Mobile Number Standard) that identifies the user.
Delete Cards
Why does the Delete API require a request body?
Why does the Delete API require a request body?
The Delete Cards API requires complex filtering parameters (campaign IDs, specific platforms, and user identifiers) which are best transmitted via a JSON body, even though this deviates from the standard REST pattern for
DELETE requests.Can I delete cards for a specific platform only?
Can I delete cards for a specific platform only?
Yes, you can specify the
platforms array in the request body (e.g., ["android"]) to delete the cards only from those specific platforms. If omitted, it deletes from all associated platforms.What is the difference between unique_id and uid?
What is the difference between unique_id and uid?
The unique_id is the unique value that identifies the user to whom the cards need to be deleted. It is a platform-specific device identifier that can be generated. The uid is the unique MoEngage Standard ID that identifies the user.