click2mail_cancel_job

WRITE: cancel a SUBMITTED job. The vendor documents this only for jobs paid by invoice and only before processing for mailing has started; otherwise it fails. The mailing is stopped for good, so get the user's explicit go-ahead first; `confirm` must be true. To remove a draft use click2mail_delete_job. POST /molpro/jobs/{id}/cancel.

destructive

Argument	Type	Description
job_id*	integer	Click2Mail job id.
confirm*	boolean	Must be true: the user approved cancelling this submitted job.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "confirm"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id.",
      "exclusiveMinimum": 0
    },
    "confirm": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: the user approved cancelling this submitted job."
    }
  }
}

click2mail_check_addresses

Validate and standardize up to 100 US postal addresses (USPS/CASS correction) before mailing. Read-only: nothing is saved or sent. POST /molpro/addressCorrection.

read-only

Argument	Type	Description
addresses*	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "addresses"
  ],
  "properties": {
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "address1",
          "city",
          "zip"
        ],
        "properties": {
          "zip": {
            "type": "string",
            "maxLength": 20,
            "minLength": 1
          },
          "city": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "name": {
            "type": "string",
            "maxLength": 150
          },
          "state": {
            "type": "string",
            "maxLength": 50
          },
          "address1": {
            "type": "string",
            "maxLength": 150,
            "minLength": 1
          },
          "address2": {
            "type": "string",
            "maxLength": 150
          }
        }
      },
      "maxItems": 100,
      "minItems": 1
    }
  }
}

click2mail_create_address_list

WRITE: upload a recipient address list (up to 500 addresses) to the account. The list is standardized (CASS) by Click2Mail; poll click2mail_get_address_list until status 3, then use its id in click2mail_create_job. Creates data only; nothing is mailed or charged. POST /molpro/addressLists.

Argument	Type	Description
name*	string	A name for the list.
addresses*	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "addresses"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "A name for the list."
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "address1",
          "city",
          "postal_code"
        ],
        "properties": {
          "city": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "state": {
            "type": "string",
            "maxLength": 50,
            "description": "State / province code, e.g. MD."
          },
          "country": {
            "type": "string",
            "maxLength": 60,
            "description": "Leave empty for the US; otherwise the country name or code."
          },
          "address1": {
            "type": "string",
            "maxLength": 150,
            "minLength": 1,
            "description": "Street line 1."
          },
          "address2": {
            "type": "string",
            "maxLength": 150
          },
          "address3": {
            "type": "string",
            "maxLength": 150
          },
          "last_name": {
            "type": "string",
            "maxLength": 100
          },
          "first_name": {
            "type": "string",
            "maxLength": 100
          },
          "postal_code": {
            "type": "string",
            "maxLength": 20,
            "minLength": 1,
            "description": "ZIP / postal code."
          },
          "organization": {
            "type": "string",
            "maxLength": 150
          }
        }
      },
      "maxItems": 500,
      "minItems": 1
    }
  }
}

click2mail_create_job

WRITE: create a mailing job from an uploaded document and an address list. The job stays a draft (status Editing): nothing is printed, mailed or charged until click2mail_submit_job. Use the exact option strings from click2mail_get_product_options. Returns the job id. POST /molpro/jobs.

Argument	Type	Description
color*	string	"Black and White" or "Full Color".
layout*	string	e.g. "Address on Separate Page", "Double Sided Postcard".
envelope	string	e.g. "#10 Double Window"; empty or "NONE" for postcards.
mail_class*	string	e.g. "First Class".
paper_type*	string	e.g. "White 24#".
project_id	integer	Project id to file the job in.
document_id*	integer	Document id (click2mail_upload_document_from_url / click2mail_list_documents).
endorsement	string	e.g. "Forwarding Service Requested".

click2mail_delete_job

WRITE: delete a job that has not been submitted (status Editing or PendingProofAcceptence). Submitted jobs cannot be deleted; use click2mail_cancel_job. POST /molpro/jobs/{id}/delete.

destructive

Argument	Type	Description
job_id*	integer	Click2Mail job id (an unsubmitted draft).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id (an unsubmitted draft).",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_estimate_cost

Estimate the cost of a mailing from its print options and quantity without creating anything (nothing is charged). Use the exact option strings from click2mail_get_product_options. GET /molpro/costEstimate.

read-only

Argument	Type	Description
color*	string	"Black and White" or "Full Color".
layout*	string	e.g. "Address on Separate Page".
envelope	string	e.g. "#10 Double Window"; "None" for postcards.
quantity*	integer	Number of mail pieces.
mail_class*	string	e.g. "First Class".
paper_type*	string	e.g. "White 24#".
payment_type	string	Default "User Credit".
print_option*	string	e.g. "Printing One side".

click2mail_get_address_list

Status of an uploaded address list: processing state (3 = CASS-standardized and ready for a job), name and counts. GET /molpro/addressLists/{id}.

read-only

Argument	Type	Description
address_list_id*	integer	Address list id from click2mail_create_address_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "address_list_id"
  ],
  "properties": {
    "address_list_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Address list id from click2mail_create_address_list.",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_get_address_list_info

Details of an address list: its addresses with the standardization result of each. Click2Mail returns 10 addresses by default: page with limit and offset. GET /molpro/addressLists/info.

read-only

Argument	Type	Description
limit	integer	How many addresses to return (vendor default 10).
offset	integer	Zero-based offset into the result list (default 0). Add the page size to page on.
address_list_id*	integer	Address list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "address_list_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 500,
      "description": "How many addresses to return (vendor default 10).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Zero-based offset into the result list (default 0). Add the page size to page on."
    },
    "address_list_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Address list id.",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_get_credit

The prepaid credit balance of the Click2Mail account (`balance`) and whether the balance may go negative (`allowNegative`). Check it before submitting a job paid with User Credit. GET /molpro/credit.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

click2mail_get_job_cost

The exact cost of a created job (postage, printing, fees) for a payment type. Read it before click2mail_submit_job. GET /molpro/jobs/{id}/cost.

read-only

Argument	Type	Description
job_id*	integer	Click2Mail job id.
details	boolean	Include the itemized breakdown.
coupon_code	string
payment_type	string	Default "Credit Card" at the vendor; use "User Credit" for account credit.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id.",
      "exclusiveMinimum": 0
    },
    "details": {
      "type": "boolean",
      "description": "Include the itemized breakdown."
    },
    "coupon_code": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1
    },
    "payment_type": {
      "enum": [
        "Credit Card",
        "Invoice",
        "ACH",
        "User Credit"
      ],
      "type": "string",
      "description": "Default \"Credit Card\" at the vendor; use \"User Credit\" for account credit."
    }
  }
}

click2mail_get_job_info

Full details of a job: print options, document, address list, dates, cost and payment. GET /molpro/jobs/info/{id}.

read-only

Argument	Type	Description
job_id*	integer	Click2Mail job id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id.",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_get_job_status

Status of a job: numeric `status` and its `description` (for example 9 = Editing) plus the status URL. GET /molpro/jobs/{id}.

read-only

Argument	Type	Description
job_id*	integer	Click2Mail job id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id.",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_get_job_tracking

USPS tracking for a submitted job: per mail piece barcode, address, status, date and location. Tracking updates once a day, so one call per day is enough; nothing is tracked on staging. GET /molpro/jobs/{id}/tracking.

read-only

Argument	Type	Description
job_id*	integer	Click2Mail job id.
bar_code	string	Only this one barcode.
tracking_type	string	IMB (Intelligent Mail barcode, default) or IMPB (package).
tracking_detail	boolean	Include the full scan history of each piece.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id.",
      "exclusiveMinimum": 0
    },
    "bar_code": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this one barcode."
    },
    "tracking_type": {
      "enum": [
        "IMB",
        "IMPB"
      ],
      "type": "string",
      "default": "IMB",
      "description": "IMB (Intelligent Mail barcode, default) or IMPB (package)."
    },
    "tracking_detail": {
      "type": "boolean",
      "description": "Include the full scan history of each piece."
    }
  }
}

click2mail_get_product_options

The mail products and valid option combinations (document class, layout, production time, envelope, color, paper, print option, mail class) for the account. Use the exact strings from this reply in click2mail_create_job and click2mail_estimate_cost. GET /molpro/productOptions.

read-only

Argument	Type	Description
document_class	string	Only this product, e.g. "Letter 8.5 x 11" or "Postcard 4.25 x 6".
skip_bulk_print	boolean	Leave out bulk-print-only options.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "document_class": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this product, e.g. \"Letter 8.5 x 11\" or \"Postcard 4.25 x 6\"."
    },
    "skip_bulk_print": {
      "type": "boolean",
      "description": "Leave out bulk-print-only options."
    }
  }
}

click2mail_list_documents

List the documents uploaded to the account (id, name, class, pages), most recent first. Use a document id when creating a job. GET /molpro/documents.

read-only

Argument	Type	Description
offset	integer	Zero-based offset into the result list (default 0). Add the page size to page on.
document_class	string	Only this class, e.g. "Letter 8.5 x 11".
number_of_documents	integer	How many documents to return, 1-100 (vendor default applies when omitted).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Zero-based offset into the result list (default 0). Add the page size to page on."
    },
    "document_class": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this class, e.g. \"Letter 8.5 x 11\"."
    },
    "number_of_documents": {
      "type": "integer",
      "maximum": 100,
      "description": "How many documents to return, 1-100 (vendor default applies when omitted).",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_list_jobs_by_app_signature

List the jobs that were created with a given `appSignature` (the label an integration puts on its jobs; click2mail_create_job sets it). GET /molpro/jobs/appSignature.

read-only

Argument	Type	Description
offset	integer	Zero-based offset into the result list (default 0). Add the page size to page on.
app_signature*	string	The appSignature value.
number_of_jobs	integer	How many jobs to return, 1-100 (vendor default applies when omitted).
ignore_tracking_data	boolean	Skip tracking data (faster).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "app_signature"
  ],
  "properties": {
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Zero-based offset into the result list (default 0). Add the page size to page on."
    },
    "app_signature": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "The appSignature value."
    },
    "number_of_jobs": {
      "type": "integer",
      "maximum": 100,
      "description": "How many jobs to return, 1-100 (vendor default applies when omitted).",
      "exclusiveMinimum": 0
    },
    "ignore_tracking_data": {
      "type": "boolean",
      "description": "Skip tracking data (faster)."
    }
  }
}

click2mail_list_project_jobs

List the mailing jobs of one project (id, status, description). This is how to see the account's jobs: pick a project from click2mail_list_projects. GET /molpro/projects/jobs.

read-only

Argument	Type	Description
offset	integer	Zero-based offset into the result list (default 0). Add the page size to page on.
project_name*	string	Exact project name, e.g. "March 2022".
number_of_jobs	integer	How many jobs to return, 1-100 (vendor default applies when omitted).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_name"
  ],
  "properties": {
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Zero-based offset into the result list (default 0). Add the page size to page on."
    },
    "project_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact project name, e.g. \"March 2022\"."
    },
    "number_of_jobs": {
      "type": "integer",
      "maximum": 100,
      "description": "How many jobs to return, 1-100 (vendor default applies when omitted).",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_list_projects

List the account's projects (jobs are grouped by project; jobs without one are grouped by month, e.g. "March 2022"), most recently updated first. Use a project name with click2mail_list_project_jobs. GET /molpro/projects.

read-only

Argument	Type	Description
offset	integer	Zero-based offset into the result list (default 0). Add the page size to page on.
number_of_projects	integer	How many projects to return, 1-100 (vendor default applies when omitted).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Zero-based offset into the result list (default 0). Add the page size to page on."
    },
    "number_of_projects": {
      "type": "integer",
      "maximum": 100,
      "description": "How many projects to return, 1-100 (vendor default applies when omitted).",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_list_return_addresses

The addresses of one type saved on the account (return addresses, billing, business reply, courtesy reply, EDDM mailer addresses) with their ids; use an id as `return_address_id` when creating a job. GET /molpro/account/addresses.

read-only

Argument	Type	Description
address_type*	string	Required by Click2Mail. The type, e.g. "Return Address", "Billing Address", "Business Reply", "Courtesy reply address", "Eddm Mailer Address".

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "address_type"
  ],
  "properties": {
    "address_type": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1,
      "description": "Required by Click2Mail. The type, e.g. \"Return Address\", \"Billing Address\", \"Business Reply\", \"Courtesy reply address\", \"Eddm Mailer Address\"."
    }
  }
}

click2mail_request_job_proof

WRITE: ask Click2Mail to render a proof (preview PDF) of a draft job. Free; nothing is mailed or charged. The reply names the proof; it takes a moment to render. POST /molpro/jobs/{id}/proof.

Argument	Type	Description
job_id*	integer	Click2Mail job id (a draft).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id (a draft).",
      "exclusiveMinimum": 0
    }
  }
}

click2mail_submit_job

WRITE, SPENDS MONEY, NOT REVERSIBLE: submit a draft job for printing and USPS mailing. This charges postage and printing to the account (User Credit = prepaid balance, or Invoice) and the physical mail is sent to every recipient. Before calling: read click2mail_get_job_cost and click2mail_get_credit, and get the user's explicit go-ahead for this job and amount. `confirm` must be true. Cancellation is only possible for Invoice jobs, before processing starts. POST /molpro/jobs/{id}/submit.

destructive

Argument	Type	Description
job_id*	integer	Click2Mail job id (a draft).
confirm*	boolean	Must be true: the user approved submitting this job and its cost.
billing_type*	string	"User Credit" charges the prepaid balance; "Invoice" bills the account. Card payments are not supported here.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "billing_type",
    "confirm"
  ],
  "properties": {
    "job_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Click2Mail job id (a draft).",
      "exclusiveMinimum": 0
    },
    "confirm": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: the user approved submitting this job and its cost."
    },
    "billing_type": {
      "enum": [
        "User Credit",
        "Invoice"
      ],
      "type": "string",
      "description": "\"User Credit\" charges the prepaid balance; \"Invoice\" bills the account. Card payments are not supported here."
    }
  }
}

click2mail_upload_document_from_url

WRITE: have Click2Mail fetch a PDF (or other supported file) from a public http(s) URL and store it as a document on the account. Returns the document id for click2mail_create_job. Creates data only; nothing is mailed or charged. POST /molpro/documents/url.

Argument	Type	Description
url*	string	Public URL of the file.
document_name*	string	A name for the document (must be unique on the account).
document_class	string	The product the document is for, e.g. "Letter 8.5 x 11", "Postcard 4.25 x 6".
document_format	string	File format, default "PDF".

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "url",
    "document_name"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000,
      "description": "Public URL of the file."
    },
    "document_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "A name for the document (must be unique on the account)."
    },
    "document_class": {
      "type": "string",
      "default": "Letter 8.5 x 11",
      "maxLength": 100,
      "minLength": 1,
      "description": "The product the document is for, e.g. \"Letter 8.5 x 11\", \"Postcard 4.25 x 6\"."
    },
    "document_format": {
      "type": "string",
      "default": "PDF",
      "pattern": "^[A-Za-z]{2,10}$",
      "description": "File format, default \"PDF\"."
    }
  }
}

Click2Mail MCP by usefulapi

Try it

click2mail_cancel_job Destructive

Click2Mail MCP by usefulapi

Try it

click2mail_cancel_job Destructive

Tools (22)