Skip to content

Set Relay Jog Duration

Set the jog duration for a specific relay. Later JOG operations use the value stored on the device.

Endpoint and Permission

http
PUT /wlte/v1/devices/{deviceId}/relays/{index}/jog-config

Requires device:config.

Request

http
PUT {baseUrl}/wlte/v1/devices/{deviceId}/relays/{index}/jog-config
Authorization: Bearer {accessToken}
Content-Type: application/json
Idempotency-Key: <caller-generated unique value>
json
{
  "durationSec": 2
}
ParameterTypeRule
indexintegerPath parameter, relay index starting at 1
durationSecintegerBody field from 1 through 8000 seconds

Success Response

json
{
  "code": "COMMAND_ACCEPTED",
  "message": "Command accepted.",
  "requestId": "req_001",
  "data": {
    "command": {
      "id": "cmd_001",
      "deviceId": "abc123456789",
      "operation": "device.relay.jogConfig.set",
      "status": "SUCCESS",
      "params": {
        "relayIndex": 1,
        "durationSec": 2
      },
      "result": {
        "relayIndex": 1,
        "durationSec": 2
      },
      "createdAt": "2026-07-15T08:30:00Z"
    }
  }
}

The HTTP status is 202 Accepted. params contains the requested values. result is returned only after device confirmation and is omitted for TIMEOUT.

Configuration changes are not broadcast over WebSocket. Use Get Device Configuration to confirm the current jog duration for each relay.

Use a new Idempotency-Key for a new configuration operation and reuse the original key when retrying the same operation. Use data.command.id with Get Command Result.

Possible errors include INVALID_REQUEST, AUTH_SCOPE_DENIED, DEVICE_NOT_FOUND, DEVICE_BUSY, DEVICE_OFFLINE, IDEMPOTENCY_CONFLICT, COMMAND_REJECTED, RATE_LIMITED, GATEWAY_UNAVAILABLE, and INTERNAL_ERROR.

Docs buildVersion v1.3.6-20260720-180213-70
Copyright © 2026 WLTE