Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Body

application/json
locale
string
required

Target locale code

Example:

"fr"

contextDocId
string

Optional document ID for the path

Example:

"cloydg3ka0005qcls5vmg8sb9"

clipboard
string

Optional clipboard content for cross-domain situations

Example:

"exampleClipboardContent"

Response

Locale path retrieved successfully

redirectTo
string
required

Path to redirect to within same hostname

Pattern: ^/(?!/).*
Example:

"/fr/page-slug"