Sign in

v2

latestOpenAPI 3.0.02026-08-07103189636.5 KB
Jobs

Update job

This updates the attributes of the job, such as job name, description, due date, and reference number. The API works in a replace-all fashion. Fields, that are not passed, will be overwritten with empty values.

put/jobs-api/v3/projects/{projectId}/jobs/{translationJobUid}

Path parameters

projectIdstring required

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

translationJobUidstring required

Request body

jobNamestring

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

descriptionstring

The description of the job.

dueDatestring date-time

The date by which the job is requested to be completed.

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

{
  "dueDate": "2020-11-21T01:51:17Z",
  "referenceNumber": "CustomerReferenceNum1",
  "callbackUrl": "https://myDomain.com",
  "callbackMethod": "GET",
  "customFields": [
    {
      "fieldUid": "3rrwchzmjf24",
      "fieldValue": "Finance Dept"
    }
  ]
}

Response

OK

Example response

{
  "response": {
    "data": {
      "createdDate": "2015-11-21T01:51:17.000Z",
      "dueDate": "2015-11-21T01:51:17.000Z",
      "firstCompletedDate": "2015-11-21T01:51:17.000Z",
      "firstAuthorizedDate": "2015-01-21T01:51:17.000Z",
      "jobNumber": "SMTL-123",
      "priority": 238,
      "lastCompletedDate": "2015-11-21T01:51:17.000Z",
      "lastAuthorizedDate": "2015-12-21T01:51:17.000Z",
      "modifiedDate": "2015-11-21T01:51:17.000Z",
      "targetLocaleIds": [
        "de-DE"
      ],
      "customFields": [
        {
          "fieldUid": "3rrwchzmjf24",
          "fieldName": "Department Name",
          "fieldValue": "Finance Dept"
        }
      ]
    }
  }
}