LOlokalise
Projects

Create a project

Changed on

Creates a new project in the specified team. Requires Admin role in the team.

Requires <code>write_projects</code> OAuth access scope.

post/projects

Request

  • Base URL
    https://api.lokalise.com/api2
  • URL
    https://api.lokalise.com/api2/projects
  • Auth
    API key in header X-Api-Token

Request body

namestring required

Name of the project.

descriptionstring

Description of the project.

base_lang_isostring

Language/locale code of the project base language. Should be in a scope of <code>languages</code> list. Use <code>custom_iso</code> code in case it was defined.

project_type'localization_files' | 'paged_documents' | 'content_integration' | 'marketing' | 'marketing_integrations'

Project type. Available types:

  • <code>localization_files</code> - Web and mobile (previously known as "Software projects") - Supports branching, individual key management, JWT/OTA tokens
  • <code>paged_documents</code> - Documents projects (Ad hoc documents) - Supports file-based management, file deletion
  • <code>content_integration</code> - Marketing projects (Marketing and support) - Limited key parameters, file-based management
  • <code>marketing</code> - Marketing projects - Automatically translated marketing projects
  • <code>marketing_integrations</code> - Marketing projects with integrations - Automatically translated marketing projects with integrations
content_integrationstring

Content integration type. Required if <code>project_type</code> = <code>content_integration</code>. Should contain one of the available integrations for your team.

is_segmentation_enabledboolean

Enable Segmentation feature for project.

Response

OK

project_idstring

A unique project identifier.

project_typestring

Project type descriptor. Allowed values are <code>localization_files</code> or <code>paged_documents</code>.

namestring

Project name.

descriptionstring

Description of the project.

created_atstring

Date of project creation.

created_at_timestampnumber

Unix timestamp when project was created.

created_bynumber

An identifier of a user who has created the project.

created_by_emailstring

An e-mail of a user who has created the project.

team_idnumber

A unique identifier of the team, the project belongs to.

base_language_idnumber

A unique identifier of the project default language.

base_language_isostring

A language/locale code of the project default language.

Changes

  • aed61e5ea90cRevision changes
    • info

      added the new optional request property

    • info

      added the new marketing enum value to the request property

    • info

      added the new marketing_integrations enum value to the request property

    • info

      request property list-of-types was widened by adding types string to media type application/json

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status