Update a Job

post

https://stage-rest.click2mail.com/molpro/jobs/{id}/update

Updates a job

Path Params

int64

required

job id

Query Params

layout

string

The specific type of the product

productionTime

string

The desired production time

envelope

string

If this is an enveloped product this determines the envelope in which the product is to be mailed; otherwise provide no value

color

string

Print in color or black and white

paperType

string

Sets the paper the mailing is to be printed on

printOption

string

Sets simplex or duplex printing

documentId

string

ID of the document to print

addressId

string

This required if the product required a recipient address list

rtnName

string

Return address Name

rtnOrganization

string

Return address Organization

rtnAddress1

string

Return address line 1

rtnAddress2

string

Return address line 2

rtnCity

string

Return address City

rtnState

string

Return address state

rtnZip

string

Return address zip code

endorsement

string

Ancillary endorsement service, the default is none

mailClass

string

Overrides the default of First Class for mailed products

appSignature

string

This is a short signature to identify orders that come from your app

projectId

int64

use to place this job in a pre-existing project in your account

mailingDate

string

Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.

quantity

string

For products that do not use mailing lists. Quantity to print

crid

string

Required for EDDM jobs

jobDocumentId

string

document ID of the job version of the document

jobAddressId

string

Address List Id of the job version

businessReplyAddressId

int64

If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account

courtesyReplyAddressId

int64

If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account

returnAddressId

int64

You may use the return address id to specify a return address already in your account

enclosure

string

Identifies the special encloure to use with this order. Special enclosures must be pre-arranged with Click2Mail

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400Job does not belong to this user. \t\n" + "Invalid product options. Sku is not unique. \t\n" + "Invalid product options. Sku not found.

404Job ID not found. \t\n DocumentId not found.