Skip to main content
PUT
/
v1
/
workers
/
{syncId}
Sync Control
curl --request PUT \
  --url https://api.jtl-cloud.com/erp/v1/workers/{syncId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '{}'
{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Path Parameters

​
syncId
string<uuid>
required

The id of the job to Restart Represents a configuration key that serves as a unique identifier for configuration entities.

Body

application/json

The Information to Control the Sync

Model Class: PutWorkerSyncAction

​
Action
enum<integer>
required

The Action to Execute

Available options:
0,
1,
2

Response

The Action is Invoked