Update

Update a job record

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areajobs.json
GeneralYesParameters described in overviewuser=user&password=userStructure of an API call
ActionYesThe action to performaction=update
Add new lookupNoFlag to add any custom field values to lookup listLookupValuesAddToLists=True
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesJob ID or UUID"jobNumber":"1/00008772"
Update dataYesData to update"jobDescription":"Softwareupdate 2"

The valid codes for "jobStatus" are 1 (quote), 2 (live), 3 (in-house), 4 (on hold) and 5 (special).

To promote a job, use the "jobSalesStatusReason" field. To get the valid codes see the Sales Status page.

Example request 1 - updating the quoted value:

http://<SERVER>/jsonapi/jobs.json?user=user&password=user&action=update&company=1&version=3.9&input={
  "data": [
    {
      "jobNumber": "1/00000105",
      "jobQuotedPrice": "99"
    }
  ]
}

Example request 2 - updating fields including a custom field & lookup value:

http://<SERVER>/jsonAPI/jobs.json?user=user&password=user&version=3.8&LookupValuesAddToLists=True&action=update&input={
  "data": [
    {
      "jobNumber": "1/00008772",
      "jobDescription": "Softwareupdate 2",
      "jobComments": "Lots of progress has been made.- aheadofschedule",
      "jobJobtypeCode": "1/PCD",
      "jobHandlerUserID": "286",
      "jobCustomField218": "MyNewText"
    }
  ]
}

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "jobNumber": "1/00008772",
      "jobUuid": "19C1C231B8DE43B5BD2BC80F8A23E699",
      "jobTimeStampModified": 1519379557,
      "jobRecommendedVersionNumber": 109
    }
  ]
}

Note:

To discover which fields are editable make a call to the "Job details" endpoint and specify '&style=modelstructure' see Meta-data

example of fields that can be updated using this endpoint:

Note: this is subject to the business rules set up on the system. For instance you can not alter the due date of a job if the system is set up to be phase dates driven.

  jobExchangeRate
  jobClientCode
  jobComments
  jobCurQuotedPrice
  jobDateIn
  jobDateDue
  jobDescription
  jobStatus
  jobOrderNumber
  jobQuotedPrice
  jobReferenceJob
  jobTaxCode
  jobOppCurrentStatus
  jobOppLeadRating
  jobOppSource
  jobOppWeighting
  jobStageNotes
  jobHandlerUserID
  jobHandlerTeam
  jobCampaignNo
  jobContactInternalRef
  jobCurrencyCode
  jobJobtypeCode
  jobProjectCode
  jobStagePriority
  jobWorkflowCode