Skip to main content
PATCH
/
api2
/
v3
/
jobs
Edit jobs (with possible partial updates)
curl --request PATCH \
  --url https://cloud.memsource.com/web/api2/v3/jobs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobs": [
    {
      "uid": "3HYnHHLkTPJfMxBCDbPXFe"
    }
  ],
  "clearDateDue": true,
  "customFields": {
    "addInstances": [
      {
        "customField": {
          "uid": "3HYnHHLkTPJfMxBCDbPXFe"
        },
        "selectedOptions": [
          {
            "uid": "3HYnHHLkTPJfMxBCDbPXFe"
          }
        ],
        "value": "<string>"
      }
    ],
    "removeInstances": [
      {
        "uid": "3HYnHHLkTPJfMxBCDbPXFe"
      }
    ],
    "updateInstances": [
      {
        "customFieldInstance": {
          "uid": "3HYnHHLkTPJfMxBCDbPXFe"
        },
        "selectedOptions": [
          {
            "uid": "3HYnHHLkTPJfMxBCDbPXFe"
          }
        ],
        "value": "<string>"
      }
    ]
  },
  "dateDue": "2023-11-07T05:31:56Z",
  "providers": [
    {
      "type": "<string>",
      "id": "<string>"
    }
  ]
}
'
import requests

url = "https://cloud.memsource.com/web/api2/v3/jobs"

payload = {
    "jobs": [{ "uid": "3HYnHHLkTPJfMxBCDbPXFe" }],
    "clearDateDue": True,
    "customFields": {
        "addInstances": [
            {
                "customField": { "uid": "3HYnHHLkTPJfMxBCDbPXFe" },
                "selectedOptions": [{ "uid": "3HYnHHLkTPJfMxBCDbPXFe" }],
                "value": "<string>"
            }
        ],
        "removeInstances": [{ "uid": "3HYnHHLkTPJfMxBCDbPXFe" }],
        "updateInstances": [
            {
                "customFieldInstance": { "uid": "3HYnHHLkTPJfMxBCDbPXFe" },
                "selectedOptions": [{ "uid": "3HYnHHLkTPJfMxBCDbPXFe" }],
                "value": "<string>"
            }
        ]
    },
    "dateDue": "2023-11-07T05:31:56Z",
    "providers": [
        {
            "type": "<string>",
            "id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    jobs: [{uid: '3HYnHHLkTPJfMxBCDbPXFe'}],
    clearDateDue: true,
    customFields: {
      addInstances: [
        {
          customField: {uid: '3HYnHHLkTPJfMxBCDbPXFe'},
          selectedOptions: [{uid: '3HYnHHLkTPJfMxBCDbPXFe'}],
          value: '<string>'
        }
      ],
      removeInstances: [{uid: '3HYnHHLkTPJfMxBCDbPXFe'}],
      updateInstances: [
        {
          customFieldInstance: {uid: '3HYnHHLkTPJfMxBCDbPXFe'},
          selectedOptions: [{uid: '3HYnHHLkTPJfMxBCDbPXFe'}],
          value: '<string>'
        }
      ]
    },
    dateDue: '2023-11-07T05:31:56Z',
    providers: [{type: '<string>', id: '<string>'}]
  })
};

fetch('https://cloud.memsource.com/web/api2/v3/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v3/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'jobs' => [
        [
                'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
        ]
    ],
    'clearDateDue' => true,
    'customFields' => [
        'addInstances' => [
                [
                                'customField' => [
                                                                'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
                                ],
                                'selectedOptions' => [
                                                                [
                                                                                                                                'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
                                                                ]
                                ],
                                'value' => '<string>'
                ]
        ],
        'removeInstances' => [
                [
                                'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
                ]
        ],
        'updateInstances' => [
                [
                                'customFieldInstance' => [
                                                                'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
                                ],
                                'selectedOptions' => [
                                                                [
                                                                                                                                'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
                                                                ]
                                ],
                                'value' => '<string>'
                ]
        ]
    ],
    'dateDue' => '2023-11-07T05:31:56Z',
    'providers' => [
        [
                'type' => '<string>',
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v3/jobs"

	payload := strings.NewReader("{\n  \"jobs\": [\n    {\n      \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n    }\n  ],\n  \"clearDateDue\": true,\n  \"customFields\": {\n    \"addInstances\": [\n      {\n        \"customField\": {\n          \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n        },\n        \"selectedOptions\": [\n          {\n            \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n          }\n        ],\n        \"value\": \"<string>\"\n      }\n    ],\n    \"removeInstances\": [\n      {\n        \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n      }\n    ],\n    \"updateInstances\": [\n      {\n        \"customFieldInstance\": {\n          \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n        },\n        \"selectedOptions\": [\n          {\n            \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n          }\n        ],\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://cloud.memsource.com/web/api2/v3/jobs")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobs\": [\n    {\n      \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n    }\n  ],\n  \"clearDateDue\": true,\n  \"customFields\": {\n    \"addInstances\": [\n      {\n        \"customField\": {\n          \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n        },\n        \"selectedOptions\": [\n          {\n            \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n          }\n        ],\n        \"value\": \"<string>\"\n      }\n    ],\n    \"removeInstances\": [\n      {\n        \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n      }\n    ],\n    \"updateInstances\": [\n      {\n        \"customFieldInstance\": {\n          \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n        },\n        \"selectedOptions\": [\n          {\n            \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n          }\n        ],\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v3/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jobs\": [\n    {\n      \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n    }\n  ],\n  \"clearDateDue\": true,\n  \"customFields\": {\n    \"addInstances\": [\n      {\n        \"customField\": {\n          \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n        },\n        \"selectedOptions\": [\n          {\n            \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n          }\n        ],\n        \"value\": \"<string>\"\n      }\n    ],\n    \"removeInstances\": [\n      {\n        \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n      }\n    ],\n    \"updateInstances\": [\n      {\n        \"customFieldInstance\": {\n          \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n        },\n        \"selectedOptions\": [\n          {\n            \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n          }\n        ],\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dateDue\": \"2023-11-07T05:31:56Z\",\n  \"providers\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "errors": [
    {
      "args": {},
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "updated": 123
}

Authorizations

​
Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Body

application/json

Job parts to update and the changes to apply

​
jobs
object[]
required

Job parts to update.

Required array length: 1 - 100 elements
​
clearDateDue
boolean

When true, clears the due date on the jobs.

​
customFields
object

Batch update of custom field instances

​
dateDue
string<date-time>

Due date to set on the jobs.

​
providers
object[]

Providers to assign to the jobs.

​
status
enum<string>

Status to set on the jobs.

Available options:
NEW,
ACCEPTED,
DECLINED,
REJECTED,
DELIVERED,
EMAILED,
COMPLETED,
CANCELLED

Response

OK

​
errors
object[]

Errors and their counts encountered during the update

​
updated
integer<int32>

Number of successfully updated job parts