Skip to content

updateJobClientRef

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/workflow/job/updateJobClientRef

POST
  • Updates a Job client ref.  
  • Looks up job by Job Ref.
  • If appendClientRef set to 1, string in the jobClientRef will be appended to existing client ref on job, else it will replace it completely. If not included in the JSON at all it assumes it is not set to 1 and replaces the ref.
acceptable request representations:

  • application/json

{    "jobs" : [        {            "jobRef":"J00HGF",            "jobClientRef":"abc123",
            "appendClientRef" : "0"        }    ]

}


available response representations:
  • 200 - application/json
{
  "result" : "success or fail",
  "result_msg" : "error message"
}

See the Workflow API matrix for the full list of endpoints in this category.