Skip to main content
A locale is a named audience definition — built from user-property filters — that you use to localize campaign messages for a language, culture, or region. For example, a locale named es-MX might target users whose last known country is Mexico. The MoEngage Locales API allows you to list the locales configured in your workspace and look up a single locale by name or ID. To create or edit a locale, use the MoEngage dashboard. For more information, see Locales.

​
Endpoints

The Locales API is a collection of the following endpoints:
  • List Locales: Returns all locales in the workspace, or a single one specified by name or ID.

​
Authentication

Authentication is done via Basic Auth. This requires a Base64-encoded string of your credentials in the format username:password.
  • Username: Use your MoEngage Workspace ID (also known as the App ID). Find it in the MoEngage dashboard at Settings > Account > API keys.
  • Password: Use an API key from Settings > Account > API keys.
Refer to API Key Dashboard for details on creating and managing API keys.

​
Pagination

The list response returns at most 20 locales per page. When pagination.has_more is true, pass pagination.next_cursor back as the cursor query parameter to fetch the next page. Treat the cursor as opaque — do not decode or modify it.

​
FAQs

​
Manage Locales

No. This endpoint is read-only. Create and edit locales from the MoEngage dashboard. For more information, see Locales.
Pass either name or id to List Locales. Supplying both returns a 400 error. Omit both to list every locale in the workspace.
No. There is no limit to the number of locales you can create in your workspace.
No. Locale names are unique within a workspace, which is why you can look up a locale by its exact name.

​
Understand the Response

It is the number of campaigns currently using the locale. This matches the Campaigns associated column on the Locales page in the dashboard.
A locale is defined by user-property filters, which MoEngage stores as a custom segment. custom_segment_id identifies that segment. It is returned only for locales that have one.

​
Related Content

​
Postman Collection

Test this endpoint using our pre-configured Postman collection: View MoEngage Locales Collection.