---
title: Configure Default Message
framework: retentionmessaging
role: symbol
role_heading: Web Service Endpoint
path: retentionmessaging/configure-default-message
---

# Configure Default Message

Configures a default message for a specific product in a specific locale.

## URL

PUT https://api.storekit.apple.com/inApps/v1/messaging/default/{productId}/{locale}

## Sandbox URL

PUT https://api.storekit-sandbox.apple.com/inApps/v1/messaging/default/{productId}/{locale}

## Path Parameters

locale: The locale for the default configuration. productId: The product identifier for the default configuration.

## Response Codes

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: The provided message or image isn’t in an approved state, so you can’t configure it as a default message. 404 Not Found: The system can’t find the message. 429 : The request exceeded the rate limit. For more information, see Identifying rate limits. 500 Internal Server Error: Server error. Try again later.

## Mentioned in

Identifying rate limits Setting up retention messages

## Discussion

Discussion When this request succeeds, the system configures the retention message you specify in the request body as the default message for productId in locale. You can configure a default message for every auto-renewable subscription’s product ID in every locale for your app. You can configure only text-based messages and text-based messages with an image as a default message. Call Get Message List and Get Image List to check the current state of messages and images, respectively. note: If either the message or the image isn’t in an APPROVED state, the request fails with an error. To replace a default message, call this endpoint again with a different message identifier. This endpoint is idempotent. If the product already has a default message for the locale, the endpoint overwrites that configuration and responds with a 200 status code. To delete a default message, call Delete Default Message. Use default messages Configure a default message for each product in each locale. If you implement the Get Retention Message endpoint, the system requires a default message for every product in each locale where you provide real-time retention messages. For more information, see Setting up your Get Retention Message endpoint. The system uses the default messages if your server response fails for any reason, or if you don’t implement the Get Retention Message endpoint. To present promotional-offer or switch-plan retention messages instead of default messages, implement the Get Retention Message endpoint to respond with those message types in real time. For more information, see Setting up your Get Retention Message endpoint.

## HTTP Body

The request body that includes the message identifier to configure as the default message.

## See Also

### Default message configuration

- [Get Default Message](retentionmessaging/get-default-message.md)
- [Delete Default Message](retentionmessaging/delete-default-message.md)
- [DefaultConfigurationRequest](retentionmessaging/defaultconfigurationrequest.md)
- [DefaultConfigurationResponse](retentionmessaging/defaultconfigurationresponse.md)