Matchai Docs

Write a translation by handComing soon

Saves your own translation of one field. Automatic translation leaves it alone from then on.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
PUT
/listings/{listing_id}/translations/{locale}/{field}

Coming soon. Saves your own translation of one field. Automatic translation leaves it alone from then on.

Scopes: listings:write

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: listings:write

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200
locale*string

Language.

Value in"en-US""fr-CA""es"
field*string

Translated field.

Value in"title""description""highlights""neighbourhood_summary""neighbourhood_tags"

Request Body

application/json
  1. body
value*|array<>

Your own translation. Text, or a list for highlights and neighbourhood_tags.

Response Body

The translation.

application/json
  1. response
listing_id*string

Listing id.

Length1 <= length <= 64
locale*Locale

A language Matchai publishes in: English (en-US), Québec French (fr-CA) or Spanish (es).

Value in"en-US""fr-CA""es"
source_locale*Locale

A language Matchai publishes in: English (en-US), Québec French (fr-CA) or Spanish (es).

Value in"en-US""fr-CA""es"
fields*array<>

Translated fields. A field that was never translated is absent.

Example Request
curl -X PUT 'https://api.matchai.co/v1/listings/string/translations/en-US/title' \  -H 'Content-Type: application/json' \  -d '{  "value": "string"}'
Example Response
{  "listing_id": "string",  "locale": "en-US",  "source_locale": "en-US",  "fields": [    {      "field": "title",      "value": "string",      "status": "automatic",      "stale": true,      "updated_at": "2019-08-24T14:15:22Z"    }  ]}