# Error codes Understand the error codes that Retention Messaging API responses return. ## Topics ### Errors [`object AltTextTooLongError`](/documentation/RetentionMessaging/AltTextTooLongError) An error that indicates the alternative text for an image is too long. [`object BodyTooLongError`](/documentation/RetentionMessaging/BodyTooLongError) An error that indicates the body text is too long. [`object DefaultMessageNotFoundError`](/documentation/RetentionMessaging/DefaultMessageNotFoundError) An error that indicates a default message isn’t configured. [`object ExistingPerformanceTestRunError`](/documentation/RetentionMessaging/ExistingPerformanceTestRunError) An error that indicates an error with an existing test. [`object ForbiddenNoPassingTestError`](/documentation/RetentionMessaging/ForbiddenNoPassingTestError) An error that indicates that passing a performance test is required before you can set a URL for the production environment. [`object HeaderTooLongError`](/documentation/RetentionMessaging/HeaderTooLongError) An error that indicates the header text is too long. [`object ImageAlreadyExistsError`](/documentation/RetentionMessaging/ImageAlreadyExistsError) An error that indicates the image identifier already exists. [`object ImageInUseError`](/documentation/RetentionMessaging/ImageInUseError) An error that indicates the image is currently in use as part of a message, so you can’t delete it. [`object ImageNotApprovedError`](/documentation/RetentionMessaging/ImageNotApprovedError) An error that indicates the image isn’t in the approved state, so you can’t configure it as part of a default message. [`object ImageNotFoundError`](/documentation/RetentionMessaging/ImageNotFoundError) An error that indicates the system can’t find the image identifier. [`object InvalidImageError`](/documentation/RetentionMessaging/InvalidImageError) An error that indicates the image that’s uploading is invalid. [`object InvalidLocaleError`](/documentation/RetentionMessaging/InvalidLocaleError) An error that indicates the locale is invalid. [`object InvalidPerformanceTestRequestError`](/documentation/RetentionMessaging/InvalidPerformanceTestRequestError) An error the API returns that indicates the performance test request is invalid. [`object InvalidProductIdError`](/documentation/RetentionMessaging/InvalidProductIdError) An error that indicates the product ID is invalid. [`object InvalidRequestIdError`](/documentation/RetentionMessaging/InvalidRequestIdError) An error that indicates the request ID is invalid. [`object MaximumNumberOfImagesReachedError`](/documentation/RetentionMessaging/MaximumNumberOfImagesReachedError) An error that indicates when you reach the maximum number of uploaded images. [`object MaximumNumberOfMessagesReachedError`](/documentation/RetentionMessaging/MaximumNumberOfMessagesReachedError) An error that indicates when you reach the maximum number of uploaded messages. [`object MessageAlreadyExistsError`](/documentation/RetentionMessaging/MessageAlreadyExistsError) An error that indicates the message identifier already exists. [`object MessageNotApprovedError`](/documentation/RetentionMessaging/MessageNotApprovedError) An error that indicates the message isn’t in the approved state, so you can’t configure it as a default message. [`object MessageNotFoundError`](/documentation/RetentionMessaging/MessageNotFoundError) An error that indicates the system can’t find the message identifier. [`object PerformanceTestRunNotFoundError`](/documentation/RetentionMessaging/PerformanceTestRunNotFoundError) An error the API returns if the service can’t find the specified test run. [`object RateLimitExceededError`](/documentation/RetentionMessaging/RateLimitExceededError) An error that indicates the request exceeded the rate limit. [`object RealtimeUrlNotFoundError`](/documentation/RetentionMessaging/RealtimeUrlNotFoundError) An error that indicates that the URL for your endpoint isn’t configured. ### Errors for bad requests [`object BadRequestAboveImageRequiresAnImageError`](/documentation/RetentionMessaging/BadRequestAboveImageRequiresAnImageError) An error that indicates that no image object is included, but the request indicates that the header should be placed above the image. [`object BadRequestAppTransactionIdForUnsupportedEndpointError`](/documentation/RetentionMessaging/BadRequestAppTransactionIdForUnsupportedEndpointError) An error that indicates the endpoint doesn’t support app transaction identifiers instead of transaction identifiers. [`object BadRequestBulletPointTextTooLongError`](/documentation/RetentionMessaging/BadRequestBulletPointTextTooLongError) An error that indicates the text for a bullet point is too long. [`object BadRequestImageSizeError`](/documentation/RetentionMessaging/BadRequestImageSizeError) An error that indicates the image size provided is invalid. [`object BadRequestRealtimeUrlError`](/documentation/RetentionMessaging/BadRequestRealtimeUrlError) An error that indicates the URL is invalid. [`object BadRequestTooManyBulletPointsError`](/documentation/RetentionMessaging/BadRequestTooManyBulletPointsError) An error that indicates there are too many bullet points. [`object BadRequestTransactionIdError`](/documentation/RetentionMessaging/BadRequestTransactionIdError) An error that indicates the transaction ID is invalid. [`object BadRequestTransactionIdNotOtidError`](/documentation/RetentionMessaging/BadRequestTransactionIdNotOtidError) An error that indicates the transaction ID provided is not an original transaction ID. [`object BadRequestTransactionIdNotSupportedForFamilySharingError`](/documentation/RetentionMessaging/BadRequestTransactionIdNotSupportedForFamilySharingError) An error that indicates that the endpoint doesn’t support transactions for products the customer receives through Family Sharing. ### Errors to retry [`object GeneralInternalError`](/documentation/RetentionMessaging/GeneralInternalError) An error that indicates a general internal error. --- Copyright © 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)