PUT v1/jobs-queue/{id}

Updates an existing job and overrides its properties with the ones provided in update.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Job UUID (id) to be updated

 string

Required

Body Parameters

Updated data

UpdateJobModel
NameDescriptionTypeAdditional information
settings

Settings to be added / updated to the job

 Collection of QueueJobSetting

None.
schedule

Time must be in Universal Time Format (UTC) Scheduled date and time the job should be run at, if not specifying one do not include. Null Schedule values are translated to "immediate", same happens for schedule times that are in the past.

 date

None.
interval

Interval in seconds between recurrent job execution. This parameter will be ignored if the job "JS: recurrent, C#: IsRecurrent" property is set to false. To set a job as recurrent, set its "JS: recurrent, C#: IsRecurrent" property to true.

 integer

None.
name

Friendly job name, set to null if you do not which to update this value.

 string

None.
statusId

Set to any status if you which to modify the status of an existing job, do not include this property if your intentions are not to modify this parameter.

 string

None.
recurrent

Set to true if you which this job be executed as a recurrent job. Note that if a job is set to recurrent but no time is specified, the default value of one day will be provided.

 boolean

None.
favorite

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "settings": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 7",
      "label": "sample string 8",
      "extraLabel": "sample string 9",
      "step": 10,
      "isTemplate": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 7",
      "label": "sample string 8",
      "extraLabel": "sample string 9",
      "step": 10,
      "isTemplate": true
    }
  ],
  "schedule": "2025-06-26T08:26:10.6986942-07:00",
  "interval": 1,
  "name": "sample string 1",
  "statusId": "sample string 2",
  "recurrent": true,
  "favorite": true
}

Response Information

Resource Description

Returns a regular http status code that specifies if the operation completed successfully.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.