job/edit

Updates an existing job.

Method and path

POST /job/edit/{job_id}

Authentication

Authentication is required. See Authentication.

Permissions

Admin and superuser users can edit jobs.

Other authenticated users are also allowed when they can view at least one project linked to the target job.

Request headers

Header	Required	Description
X-Api-Key or X_API_KEY	yes	API key.
Content-Type	yes	application/json.

Path parameters

Parameter	Type	Required	Description
job_id	integer	yes	Job identifier.

Request body

Field	Type	Required	Description
type	string	no	Job type code.
label	string	no	Job label.
active	boolean	no	Active state.
freq	integer	no	Execution interval in seconds.
notes	string	no	Free-text notes.
search	string	no	Search string.
searchLang	string	no	Search language code.
searchJson	object	no	Structured search object used by composed search platforms.
options	object	no	Additional options, including platform-specific settings.
projects	array<integer>	no	Full replacement list of linked project ids.
limited	boolean	no	Limited-mode flag. Backend rules can override this value.

Example request

curl -X POST "$SIGNAL_API_BASE_URL/job/edit/<job_id>" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Example Job",
    "type": "nftw",
    "active": true,
    "freq": "<frequency_seconds>"
  }'

{
  "label": "Example Job",
  "type": "nftw",
  "active": true,
  "freq": "<frequency_seconds>",
  "notes": "Example notes",
  "searchJson": {
    "all": "\"example phrase\"",
    "authors": "example_account"
  },
  "options": {},
  "projects": ["<project_id>"]
}

Example response

{
  "id": "<job_id>",
  "label": "Example Job",
  "type": "nftw",
  "freq": "<frequency_seconds>",
  "notes": "Example notes",
  "lastrun": "<unix_timestamp_or_null>",
  "active": true,
  "limited": false,
  "searchLang": "<language_code_or_null>",
  "search": "<search_string_or_json>",
  "options": {},
  "toRestart": null,
  "efficiency": null,
  "projects": ["<project_id>"]
}

Notes

• The endpoint dequeues the job before saving changes.
• If the saved job is active, it is enqueued again after the update.