About Notification Locales

What are Notification Locales?

Notification Locale allows us to set up the preferred languages for notifications from Cirro.

Endpoints

POST https://cirro.io/api/v2/notification_locales GET https://cirro.io/api/v2/notification_locales

The Notification Locale object

Notification Locale Attributes

Attribute	Type	Description
`id`	`string`	The unique identifier for the Notification Locale.
`object`	`string`	The type of the object, in this case, it's 'notification_locale'.
`default`	`boolean`	Indicates whether this locale is the default one.
`locale`	`string`	The locale code like 'de', 'en', etc.
`configurations`	`object`	An object containing a list of notification configurations.

Notification Configuration Attributes

Attribute	Type	Description
`object`	`string`	The type of the object inside the configurations list, it's 'list'.
`id`	`string`	The unique identifier for the Notification Configuration.
`object`	`string`	The type of the object, in this case, it's 'notification_configuration'.
`deliver_by`	`string`	The method to deliver the notification, for example 'email'.
`format`	`string`	The format of the notification, for example 'html' or 'text'.
`kind`	`string`	The kind of the notification, for example 'standalone' or 'digest'.
`locale`	`string`	The locale for the notification configuration.

Example

{
  "id": "1",
  "object": "notification_locale",
  "default": false,
  "locale": "de",
  "configurations": {
    "object": "list"
    "data": [
      {
        "id": "1",
        "object": "notification_configuration",
        "deliver_by": "email",
        "format": "html",
        "kind": "standalone",
        "locale": "de"
      },
      {
        "id": "2",
        "object": "notification_configuration",
        "deliver_by": "email",
        "format": "text",
        "kind": "standalone",
        "locale": "de"
      },
      {
        "id": "3",
        "object": "notification_configuration",
        "deliver_by": "email",
        "format": "html",
        "kind": "digest",
        "locale": "de"
      },
      {
        "id": "3",
        "object": "notification_configuration",
        "deliver_by": "email",
        "format": "text",
        "kind": "digest",
        "locale": "de"
      }
    ]
  }
}