Jobs

Create job

Changed on Oct 17, 2026

Creates a job within Smartling.

post/jobs-api/v3/projects/{projectId}/jobs

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.

Request body

jobNamestring

The name of the job to create. It must be unique within the Smartling project. jobName is required.

targetLocaleIdsLocaleId[]

The array of localeIds to be used when creating the job. The locales specified must be valid within the Smartling project.

descriptionstring

The description of the job. The description is limited to 8,000 characters.

dueDatestring date-time

ISO 8601 UTC timestamp.

referenceNumberstring

Customer specific number/identifier for the job.

callbackUrlstring

The URL for Smartling to invoke when the job is completed.

callbackMethodstring

The HTTP method to call (GET|POST) when invoking the callbackUrl.

Example request

{
  "jobName": "This is my job name.",
  "targetLocaleIds": [
    "ru-RU"
  ],
  "description": "This is my job description.",
  "dueDate": "2026-01-15T10:00:00Z",
  "referenceNumber": "referenceNumb1",
  "callbackUrl": "https://myDomain.com",
  "callbackMethod": "GET",
  "customFields": [
    {
      "fieldUid": "3rrwchzmjf24",
      "fieldValue": "Finance Dept"
    }
  ]
}

Response

Example response

{
  "response": {
    "data": {
      "createdByUserUid": "99b0662fbae1",
      "createdDate": "2026-01-15T10:00:00Z",
      "dueDate": "2026-01-15T10:00:00Z",
      "firstCompletedDate": "2026-01-15T10:00:00Z",
      "firstAuthorizedDate": "2026-01-15T10:00:00Z",
      "jobNumber": "SMTL-123",
      "jobStatus": "DRAFT | AWAITING_AUTHORIZATION | IN_PROGRESS | COMPLETED | CANCELLED | CLOSED",
      "lastCompletedDate": "2026-01-15T10:00:00Z",
      "lastAuthorizedDate": "2026-01-15T10:00:00Z",
      "modifiedByUserUid": "99b0662fbae1",
      "modifiedDate": "2026-01-15T10:00:00Z",
      "targetLocaleIds": [
        "fr-FR"
      ],
      "customFields": [
        {
          "fieldUid": "3rrwchzmjf24",
          "fieldName": "Department Name",
          "fieldValue": "Finance Dept"
        }
      ],
      "translationJobUid": "j45v1uvsi3tx",
      "referenceNumber": "CustomerReferenceNum1"
    }
  }
}

Changes

Oct 17, 20262cd7a8215799 Revision changes
- breaking
  added the pattern ^[a-z0-9]{9}$ to the path request parameter projectId
- breaking
  added to the request property allOf list
- breaking
  added the pattern ^[a-z]{2}(-[A-Z]{2})?$ to the request property /
- breaking
  the request property type changed from string to no type, and format from date-time to no format
- 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
- breaking
  the /// response's property type changed from string to no type for status
- breaking
  the /// response's property type changed from string to no type for status
- info
  added to the /// response property allOf list for the response status
- info
  added to the /// response property allOf list for the response status
- info
  the //// response's property pattern ^[a-z]{2}(-[A-Z]{2})?$ was added for the status
- info
  the /// response's property pattern ^[a-z0-9]{12}$ was added for the status
Aug 6, 2026ae422098d9c5 Revision changes
- warning
  the request property's maxLength was set to 8192
- info
  added the new optional request property
- info
  for the path request parameter projectId, the format was generalized from uuid to no format
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status

Operation history