Jobs

Add locale to job

Changed on

This adds a locale to a job. When the system can quickly add the locale and any content to the job, it synchronously responds with status 200. When the system can't quickly add the locale and any content to the job, a 202 response is returned. The response contains a link to check the progress of the request. When a 202 is received, the process of adding the content to the job will not be complete until the returned process has completed.

post/jobs-api/v3/projects/{projectId}/jobs/{translationJobUid}/locales/{targetLocaleId}

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Unique identifier of a Smartling project — 9 lowercase alphanumeric characters.

Example:84c012a33

A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

translationJobUidstring required

Translation job unique identifier — 12 lowercase alphanumeric characters.

Example:j45v1uvsi3tx
targetLocaleIdstring required

Locale identifier. Either a 2-letter language code (en) or a language-region pair (en-US). The language part is always lowercase; the region part is always uppercase.

Example:fr-FR

Request body

syncContentboolean

When a new locale is being added to a job, by default all content in the job will be added to the job for the new locale. If set to false, then no content will be added to the job, and only a locale placeholder will be added to the job.

Response

OK

Changes

    • breaking

      added the pattern ^[a-z0-9]{12}$ to the path request parameter translationJobUid

    • breaking

      added the pattern ^[a-z0-9]{9}$ to the path request parameter projectId

    • breaking

      added the pattern ^[a-z]{2}(-[A-Z]{2})?$ to the path request parameter targetLocaleId

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      the // response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status

    • breaking

      added required request body

    • warning

      deleted the query request parameter syncContent