Click2Mail MCP by usefulapi

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.

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

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.

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

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.

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

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.

{
  "type": "object",
  "properties": {
    "document_class": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"Letter 8.5 x 11\"."
    },
    "layout": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"Address on Separate Page\"."
    },
    "production_time": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "e.g. \"Next Day\"."
    },
    "envelope": {
      "description": "e.g. \"#10 Double Window\"; \"None\" for postcards.",
      "type": "string",
      "maxLength": 100
    },
    "color": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "\"Black and White\" or \"Full Color\"."
    },
    "paper_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"White 24#\"."
    },
    "print_option": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"Printing One side\"."
    },
    "mail_class": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"First Class\"."
    },
    "quantity": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 10000000,
      "description": "Number of mail pieces."
    },
    "number_of_pages": {
      "description": "Pages per piece.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 10000
    },
    "non_standard_quantity": {
      "description": "How many pieces are non-standard (optional).",
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000
    },
    "international_quantity": {
      "description": "How many pieces go abroad (optional).",
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000
    },
    "payment_type": {
      "description": "Default \"User Credit\".",
      "type": "string",
      "enum": [
        "Credit Card",
        "Invoice",
        "ACH",
        "User Credit"
      ]
    }
  },
  "required": [
    "document_class",
    "layout",
    "production_time",
    "color",
    "paper_type",
    "print_option",
    "mail_class",
    "quantity"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

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

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

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

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.

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

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

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

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

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

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.

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

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.

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

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.

{
  "type": "object",
  "properties": {
    "document_class": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"Letter 8.5 x 11\", \"Postcard 4.25 x 6\"."
    },
    "layout": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"Address on Separate Page\", \"Double Sided Postcard\"."
    },
    "production_time": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "e.g. \"Next Day\"."
    },
    "envelope": {
      "default": "",
      "description": "e.g. \"#10 Double Window\"; empty or \"NONE\" for postcards.",
      "type": "string",
      "maxLength": 100
    },
    "color": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "\"Black and White\" or \"Full Color\"."
    },
    "paper_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"White 24#\"."
    },
    "print_option": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"Printing One side\", \"Printing both sides\"."
    },
    "mail_class": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "e.g. \"First Class\"."
    },
    "document_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Document id (click2mail_upload_document_from_url / click2mail_list_documents)."
    },
    "address_list_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Address list id (click2mail_create_address_list), status 3."
    },
    "return_address_id": {
      "description": "Saved return address id (click2mail_list_return_addresses).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "endorsement": {
      "description": "e.g. \"Forwarding Service Requested\".",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "app_signature": {
      "description": "Label to find the job again with click2mail_list_jobs_by_app_signature.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "project_id": {
      "description": "Project id to file the job in.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "mailing_date": {
      "type": "string",
      "pattern": "^\\d{8}$",
      "description": "A date, yyyymmdd."
    }
  },
  "required": [
    "document_class",
    "layout",
    "production_time",
    "color",
    "paper_type",
    "print_option",
    "mail_class",
    "document_id",
    "address_list_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

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

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.

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

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.

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

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.

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