API reference

Languages details

Company language management

Find languages

GET

List languages available for the company.

Query parameters:

Name	Type	Required	Description
`property_id`	string	No	Optional property context
`include_deleted`	boolean	No	Include deleted languages

200Languages retrieved successfullyapplication/json

resultobject[]optional

Show properties

idstringoptional

Language code (ISO 639-1)

namestringoptional

Language name

countrystringnullableoptional

Associated country code

is_activebooleanoptional

Whether language is active

is_custombooleanoptional

Whether language is custom (not system default)

is_deletedbooleanoptional

Soft deletion flag

get/admin/company/languages

GET /api/admin/company/languages HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Languages retrieved successfully

{
  "result": [{
    "id": "EN",
    "name": "English",
    "country": "US",
    "is_active": true,
    "is_custom": false,
    "is_deleted": false
  }]
}

Create language

POST

Create a custom language for the company or property.

Request bodyapplication/json

property_idstringoptional

Optional property ID for property-level language

codestringrequired

Language code (uppercase)

namestringrequired

Language name

is_activebooleanoptional

Active status

200Language created successfullyapplication/json

resultobjectoptional

Language information

Show properties

idstringoptional

Language code (ISO 639-1)

namestringoptional

Language name

countrystringnullableoptional

Associated country code

is_activebooleanoptional

Whether language is active

is_custombooleanoptional

Whether language is custom (not system default)

is_deletedbooleanoptional

Soft deletion flag

post/admin/company/languages

POST /api/admin/company/languages HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "property_id": "string",
  "code": "DE",
  "name": "German",
  "is_active": false
}

200Language created successfully

{
  "result": {
    "id": "EN",
    "name": "English",
    "country": "US",
    "is_active": true,
    "is_custom": false,
    "is_deleted": false
  }
}

Export property language data

GET

Download a property's languages and translations as a signed JSON attachment.

Query parameters:

Name	Type	Required	Description
`property_id`	string	Yes	Property to export.

```schema response 200 Language export payload (downloadable JSON attachment, not { result }-wrapped). {"type":"object","properties":{"languages":{"type":"object","description":"Exported property-level languages."},"translations":{"type":"object","description":"Exported property translations."},"kind":{"type":"string","description":"Export type marker, always EXPORT_LANGUAGE.","example":"EXPORT_LANGUAGE"},"filter":{"type":"object","properties":{"property_id":{"type":"string","format":"uuid"},"company_id":{"type":"string","format":"uuid"}}},"sv":{"type":"string","description":"Integrity signature validated on import."}}}


```http-response 200 Language export payload (downloadable JSON attachment, not `{ result }`-wrapped).
{
  "languages": {},
  "translations": {},
  "kind": "EXPORT_LANGUAGE",
  "filter": {
    "property_id": "string",
    "company_id": "string"
  },
  "sv": "string"
}

get/admin/company/languages/export

GET /api/admin/company/languages/export HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Import property language data

POST

Import a previously exported language payload into a property.

Request bodyapplication/json

property_idstringrequired

Property to import into.

contentobjectrequired

Full export payload, including `sv` signature and `kind: EXPORT_LANGUAGE`.

200Import summary.application/json

resultobjectoptional

Show properties

languagesobject[]optional

Languages created in the property.

translationsobjectoptional

Translation import result.

post/admin/company/languages/import

POST /api/admin/company/languages/import HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "property_id": "string",
  "content": {}
}

200Import summary.

{
  "result": {
    "languages": [{}],
    "translations": {}
  }
}

Read language

GET

Get details for a specific language.

Query parameters:

Name	Type	Required	Description
`property_id`	string	No	Optional property context

200Language details retrieved successfullyapplication/json

resultobjectoptional

Language information

Show properties

idstringoptional

Language code (ISO 639-1)

namestringoptional

Language name

countrystringnullableoptional

Associated country code

is_activebooleanoptional

Whether language is active

is_custombooleanoptional

Whether language is custom (not system default)

is_deletedbooleanoptional

Soft deletion flag

get/admin/company/languages/{id}

GET /api/admin/company/languages/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Language details retrieved successfully

{
  "result": {
    "id": "EN",
    "name": "English",
    "country": "US",
    "is_active": true,
    "is_custom": false,
    "is_deleted": false
  }
}

Update language

PUT

Update an existing language.

Request bodyapplication/json

property_idstringoptional

Optional property context

namestringoptional

Language name

is_activebooleanoptional

Active status

200Language updated successfullyapplication/json

resultobjectoptional

Show properties

changedbooleanoptional

put/admin/company/languages/{id}

PUT /api/admin/company/languages/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "property_id": "string",
  "name": "string",
  "is_active": false
}

200Language updated successfully

{
  "result": {
    "changed": true
  }
}

Delete language

DELETE

Soft-delete a language from the company or property.

Query parameters:

Name	Type	Required	Description
`property_id`	string	No	Optional property context

200Language deleted successfullyapplication/json

resultobjectoptional

Show properties

deletedbooleanoptional

delete/admin/company/languages/{id}

DELETE /api/admin/company/languages/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Language deleted successfully

{
  "result": {
    "deleted": true
  }
}