API reference

Legal documents

Export and import legal documents.

Export legal documents (policies)

GET

Export the property's policies as a signed JSON file.

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes	Property short UUID.

Query parameters:

Name	Type	Required	Description
`project`	array	No	Optional policy projects to restrict the export.

200Legal documents export file.application/json

policiesobjectoptional

Exported policy rows.

policy_versionsobjectoptional

Exported policy version rows.

policy_attachmentsobjectoptional

Exported policy attachment rows.

policy_countriesobjectoptional

Exported policy country mapping rows.

kindstringenumoptional

Export type marker.

Possible values: EXPORT_POLICY

filterobjectoptional

Scope (company_id / property_id / project).

svstringoptional

Payload signature, verified on import.

get/admin/properties/{property_id}/legal-documents/export

GET /api/admin/properties/{property_id}/legal-documents/export HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Legal documents export file.

{
  "policies": {},
  "policy_versions": {},
  "policy_attachments": {},
  "policy_countries": {},
  "kind": "EXPORT_POLICY",
  "filter": {},
  "sv": "string"
}

Import legal documents (policies)

POST

Import a policies bundle, replacing policies matching the export filter.

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes	Property short UUID.

Request bodyapplication/json

contentobjectrequired

The policies export object, with its `sv` and `kind`.

200Imported records summary.application/json

resultobjectoptional

Show properties

policiesobject[]optional

Recreated policies.

policy_versionsobject[]optional

Recreated policy versions.

policy_attachmentsobject[]optional

Recreated policy attachments.

policy_countryobject[]optional

Recreated policy country mappings.

post/admin/properties/{property_id}/legal-documents/import

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

{
  "content": {}
}

200Imported records summary.

{
  "result": {
    "policies": [{}],
    "policy_versions": [{}],
    "policy_attachments": [{}],
    "policy_country": [{}]
  }
}