Get Email Translation Status

GET

/api/v1/workspaces/{workspace_id}/emails/{id}/translation_status

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/translation_status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/translation_status \
  --header 'Authorization: Bearer <token>'

Retrieves the email’s translation state - whether a translation job is in flight, and per locale which fields are stale or untranslated.

Authorizations

OAuth2
emails:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

Email ID

Responses

200

Successful

application/json

object

translation_in_progress

required

boolean

active_job

required

One of:

object
null

object

required

integer

email_id

required

integer

provider

required

How the job is fulfilled.

string

Allowed values: ai csv deepl phrase_tms

connector_id

required

The localization connector fulfilling this job, or null for built-in providers.

integer | null

status

required

string

Allowed values: pending in_progress completed failed cancelled

source_locale

required

A BCP 47 language tag identifying the language and region of a piece of content. Must carry both a language and a region subtag, and must be in canonical case (lowercase language, titlecase script, uppercase region) — en-GB, not en-gb or en_GB. The region may be a UN M.49 code, so en-001 (world) is valid.

string

locales

required

Per-target-locale progress.

Array<object>

object

locale

required

string

status

required

string

Allowed values: pending in_progress completed failed cancelled

error_message

string | null

created_at

required

string format: date-time

completed_at

required

string | null format: date-time

Example

{
  "translation_in_progress": false,
  "active_job": {
    "id": 12345,
    "email_id": 12345,
    "provider": "ai",
    "connector_id": 12345,
    "status": "pending",
    "source_locale": "en-GB",
    "locales": [
      {
        "locale": "en-GB",
        "status": "pending"
      }
    ],
    "created_at": "2023-08-23T10:30:00.000Z",
    "completed_at": "2023-08-23T10:30:00.000Z"
  }
}

401

Unauthorized

application/json

object

message

required

string

code

string

Example

{
  "message": "Record not found",
  "code": "share_link_expired"
}

403

Forbidden

application/json

object

message

required

string

code

string

Example

{
  "message": "Record not found",
  "code": "share_link_expired"
}

404

Not Found

application/json

object

message

required

string

code

string

Example

{
  "message": "Record not found",
  "code": "share_link_expired"
}