API Documentation
Toggle TOC panel

URL structure

1 https://access-service.xy-company.com/api/v1/i18n/adminpreference

Supported methods and overview

  • PUT - sets a supported locale as the SafeShare administrator's default locale.

Detailed description

This API endpoint sets a supported locale as the SafeShare administrator's default locale. This is equivalent to setting the System Default language through the Internationalization page of SafeShare Administration.

The SafeShare administrator's default locale serves a number of purposes:

  • This locale (and language) is the default used for the Cocoon Data Sign-in page, Cocoon Data email notifications and the SafeShare Administration, Organisation Administration and SafeShare for Web user interfaces.
  • This is the initial locale used for all newly created Cocoon Data users.
  • When a custom locale without an existing internationalization (i18n) bundle is deleted, any Cocoon Data users utilizing this locale (which they would have chosen through SafeShare) will automatically be reverted to use this SafeShare administrator's default locale.

Supported roles

This API endpoint supports the following Cocoon Data user roles (as described in the SafeShare Administrator's Guide):

The Cocoon Data Platform's resources available to a Cocoon Data user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

  • Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

The following header is required if the body of the request has a JSON object:

  • Content-Type: application/json

Required parameters

The following required parameter must be sent in the body of the PUT request, as an individual member of a JSON object:

  • i18nCode - A supported i18n code, where supported refers to a locale/language which is available through a language bundle on the Cocoon Data Platform.
    Tip: Valid i18n codes values are listed in the I18n Code column on the Internationalization page of SafeShare Administration.
    Example (request):
    "i18nCode": "en_us"


If the request succeeded, then an HTTP response status 200 OK is returned.

For successful requests only, the following string is returned in the body of the response:

1 "OK"