Delete Message
Deletes a previously uploaded message.
URL
DELETE https://api.storekit.apple.com/inApps/v1/messaging/message/{messageIdentifier}Sandbox URL
DELETE https://api.storekit-sandbox.apple.com/inApps/v1/messaging/message/{messageIdentifier}Path Parameters
| Name | Type | Description |
|---|---|---|
messageIdentifier Required | messageIdentifier | The identifier of the message to delete. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK | Request succeeded. | |
| 400 | Bad Request | The request is invalid and unacceptable. | |
| 401 | Unauthorized | The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. | |
| 404 | Not Found Content-Type: application/json | MessageNotFoundError | The system can’t find the message. |
| 429 | Content-Type: application/json | RateLimitExceededError | The request exceeded the rate limit. For more information, see Identifying rate limits. |
| 500 | Internal Server Error Content-Type: application/json | GeneralInternalError | Server error. Try again later. |
Mentioned in
Discussion
Call this endpoint to delete a message. After successfully deleting the message, its messageIdentifier no longer exists.
To avoid errors, don’t use the messageIdentifier of deleted messages in RealtimeResponseBody when your server replies to the Get Retention Message endpoint.
To delete an image associated with a message, call Delete Image after you delete the message.