Sign in

v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Jobs

Modify job

Requires the JOBEDIT security role. Note: responsibleID and responsibleGroupID cannot be set on previousStage, activeStage, or nextStage through this endpoint. To update a stage's responsible user or group, use PUT /api/workflow/stages/{id}.

put/api/workflow/jobs/{id}

Path parameters

idstring required

Request body

namestring

Name of the job

descriptionstring

Description of the job

deadlinestring

Date of when the job ends

campaignIDstring

Id of the campaign the job is part of

accountableIDstring

Id of the user accountable for the job (displayed as Reporter in the UI). This does not update a stage's responsible user or group; use PUT /api/workflow/stages/{id} for that.

jobMetapropertiesobject

ID and metaproperty values

Example request

{
  "name": "Job Example",
  "description": "Job Description",
  "deadline": "2018-09-29",
  "campaignID": "00000000-0000-0000-0000-000000000000",
  "accountableID": "00000000-0000-0000-0000-000000000000",
  "jobMetaproperties": {
    "00000000-0000-0000-0000-000000000000": "00000000-0000-0000-0000-000000000000"
  },
  "activeStage": {
    "id": "00000000-0000-0000-0000-000000000002",
    "deadline": "2024-08-31T00:00:00+00:00",
    "status": "Active"
  },
  "nextStage": {
    "id": "00000000-0000-0000-0000-000000000003",
    "deadline": "2024-08-31T00:00:00+00:00",
    "status": "Idle"
  },
  "previousStage": {
    "id": "00000000-0000-0000-0000-000000000001",
    "status": "Approved"
  }
}

Response

Successful response

statusstring
job_idstring

Example response

{
  "status": "Updated",
  "job_id": "00000000-0000-0000-0000-000000000000"
}