Skip to content
Documentation

Create Email Translation

POST
/api/v1/workspaces/{workspace_id}/emails/{id}/email_translations
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/email_translations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target_locales": [ "fr-FR", "de-DE" ] }'

Creates a new Email Translation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

id
required
integer

Email ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
target_locales
required

The locales to translate the email into.

Array<string>
Example
[
  "fr-FR",
  "de-DE"
]

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
id
required
integer
email_id
required
integer
organization_id
integer
target_locales
required
Array<string>
status
required
string
Allowed values: in_progress completed failed
locale_statuses
required
object
key
additional properties
string
Allowed values: in_progress completed failed
Example
{
  "id": 12345,
  "email_id": 12345,
  "organization_id": 12345,
  "status": "in_progress",
  "locale_statuses": {
    "additionalProperty": "in_progress"
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}