Skip to content

Create A New Job

Request

Either template_name or template_id is the only required field for creating a new job using this API. Everything else is optional

The sample in this section creates a job from a template called "Sample Template".

You can see in the reply that this template includes three steps and one example of each of the custom field types.

Depending on what features are configured in your account, you may see additional fields. More detailed information on other possible fields are available in the following sections.

Security
apiKey
Query
api_keystringrequired
Headers
Accept-Encodingstringrequired

Must be gzip. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).

Value:"gzip"
Example:gzip
Bodyapplication/xml; charset=utf-8
string

Raw XML payload — see the example.

POST
/v5/jobs/clone.xml
curl -i -X POST \
  'https://api.vworkapp.com/api/v5/jobs/clone.xml?api_key=string&api_key=YOUR_API_KEY_HERE' \
  -H 'Accept-Encoding: gzip' \
  -H 'Content-Type: application/xml; charset=utf-8' \
  -d '<?xml version="1.0" encoding="utf-8"?>
  <job>
      <template_name>Sample Template</template_name>
  </job>'

Responses

OK

Headers
Statusstring
Example:"200 OK"
Cache-Controlstring
Example:"max-age=0, private, must-revalidate"
Content-Encodingstring
Example:"gzip"
Bodyapplication/xml; charset=utf-8
string

Raw XML payload — see the example.

Response
<?xml version="1.0" encoding="utf-8"?>
<job>
<id readonly="readonly">26780729</id>
<job_type readonly="readonly">job</job_type>
<status>unassigned</status>
<third_party_id></third_party_id>
<customer_name></customer_name>
<template_name>Sample Template</template_name>
<customer_id></customer_id>
<customer_third_party_id></customer_third_party_id>
<worker_id></worker_id>
<worker_third_party_id></worker_third_party_id>
<worker_name></worker_name>
<worker_duration>0</worker_duration>
<published_at type="datetime"></published_at>
<published_by readonly="readonly"></published_by>
<has_pod readonly="readonly">false</has_pod>
<signed_at readonly="readonly"></signed_at>
<signed_by readonly="readonly"></signed_by>
<paused_at></paused_at>
<planned_duration>10800</planned_duration>
<planned_start_at type="datetime"></planned_start_at>
<planned_end_at type="datetime" readonly="readonly"></planned_end_at>
<actual_start_at type="datetime" readonly="readonly"></actual_start_at>
<actual_duration reado…