Skip to main content
PUT
/
v2
/
workers
/
control
Controls a worker sync (start, stop or restart).
curl --request PUT \
  --url https://api.jtl-cloud.com/erp/v2/workers/control \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "syncId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

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.

Body

application/json

Request parameters

Controls a worker sync (start, stop or restart). - Request

​
syncId
string<uuid>

The id of the sync to control.

​
action
enum<integer>

The control action to execute.

Available options:
0,
1,
2

Response

204 - application/json

The action was invoked.