Delete Image
Deletes a previously uploaded image.
URL
DELETE https://api.storekit.apple.com/inApps/v1/messaging/image/{imageIdentifier}Sandbox URL
DELETE https://api.storekit-sandbox.apple.com/inApps/v1/messaging/image/{imageIdentifier}Path Parameters
| Name | Type | Description |
|---|---|---|
imageIdentifier Required | imageIdentifier | The identifier of the image 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.. | |
| 403 | Forbidden Content-Type: application/json | ImageInUseError | The request is forbidden because the image is in use. |
| 404 | Not Found Content-Type: application/json | ImageNotFoundError | The system can’t find the image. |
| 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 an image. After successfully deleting the image, its imageIdentifier no longer exists. Don’t use the imageIdentifier of a deleted image in any new messages.
This endpoint isn’t idempotent. If the system doesn’t find the image, this endpoint throws an error.