<!--
{
  "availability" : [
    "Retention Messaging API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RetentionMessaging",
  "identifier" : "/documentation/RetentionMessaging/Configure-Default-Message",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Retention Messaging API"
    ],
    "preciseIdentifier" : "rest:retention_messaging:put:inApps-v1-messaging-default-{}-{}"
  },
  "title" : "Configure Default Message"
}
-->

# Configure Default Message

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

## 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`](/documentation/RetentionMessaging/Get-Message-List) and [`Get Image List`](/documentation/RetentionMessaging/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`](/documentation/RetentionMessaging/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](/documentation/RetentionMessaging/setting-up-retention-messaging-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](/documentation/RetentionMessaging/setting-up-retention-messaging-endpoint).

---

Copyright &copy; 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)