Create a Job

Once you have credit in your account, a document uploaded, and an address list created, it's time to create the job that you want to execute. The job process consists of first creating a job and getting its ID, then submitting the job. Job creation is done with a POST to the /jobs endpoint.

Creating a job has 9 required parameters, and a large number of optional parameters that are beyond the scope of this tutorial.

Job Creation Required Parameters

The following Python code example creates a job using document 12345 and address list 78902 with a typical set of options:

# Load the HTTP requests module
import requests

# Define the endpoint to use
url = "https://stage-rest.click2mail.com/molpro/jobs"

# Define credentials
myusername = 'awesomeuser'
mypassword = 'gReAt/PaSsWoRd123'

headers = {'user-agent': 'my-app/0.0.1'}

# Build the dictionary of parameters to describe the job
values = {'documentClass' : 'Letter 8.5 x 11',
          'layout'        : 'Address on Separate Page',
          'productionTime': 'Next Day',
          'envelope'      : '#10 Double Window',
          'color'         : 'Black and White',
          'paperType'     : 'White 24#',
          'printOption'   : 'Printing One side',
          'documentId'    : 12345,
          'addressId'     : 78902}

# Make the POST call
r = requests.post(url, data=values, headers=headers, auth=(myusername, mypassword))

# Display the result - a success should return status_code 201
print(r.status_code)

# Display the full XML returned.
print(r.text)

A successful call should return an HTTP 201 status and the XML similar to the following:

201
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<job>
    <id>13331417</id>
    <status>0</status>
    <description>Created</description>
    <statusUrl>https://stage-rest.click2mail.com/molpro/jobs/13331417</statusUrl>
</job>

HTTP Return Codes And Possible Statuses

HTTP Response 200

HTTP Response 400

HTTP Response 500
If a 500 error is returned, please contact Click2Mail support.