Push

Delete message from inbox

Delete a Message Center message completely, removing it from every user's inbox. This is an asynchronous call. A success response means that the deletion has been queued for processing.

This delete call will work with either the message_id or the push_id of the accompanying push notification.

This endpoint will not work with a group ID from an automated message or a push to local time delivery. To delete a Message Center message that was part of an automated or local time delivery, you can provide a group ID to the batch-delete endpoint.

delete/api/user/messages/{push_id}

Request

Path parameters

push_idstring required

The push_id or message_id of the Message Center message you want to delete from users' inboxes.

Response

The request has been accepted for processing.

okboolean required

Success.

operation_idstring uuid

A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple push_id strings, but a single operation_id) or operations that change an existing resource.

Changes

No recorded changes to this operation across all 9 revisions of this API.