Get Default Message
Gets the default message for a specific product in a specific locale, if it’s configured.
URL
GET https://api.storekit.apple.com/inApps/v1/messaging/default/{productId}/{locale}Sandbox URL
GET https://api.storekit-sandbox.apple.com/inApps/v1/messaging/default/{productId}/{locale}Path Parameters
| Name | Type | Description |
|---|---|---|
locale Required | locale | The locale of the message. |
productId Required | productId | The product identifier of the message. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | DefaultConfigurationResponse | Request succeeded. |
| 400 | Bad Request Content-Type: application/json | (InvalidProductIdError | InvalidLocaleError) | 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 | DefaultMessageNotFoundError | The default message for the specified product ID and locale wasn’t found. |
| 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 retrieve the default message you previously configured for a specific product in a specific locale. If a default message isn’t configured, the endpoint returns an HTTP 404 error with DefaultMessageNotFoundError.
For information about setting up default messages, see Setting up retention messages.