Create a campaign
create_campaignCreates a new campaign: the seller's design printed on a catalogue product (plus optional additional products), with selling price and colours. The design is an image uploaded on a personal Hoplix upload page (front_design_upload_id / back_design_upload_id) or a public http(s) URL of a PNG or JPG image (front_image_url / back_image_url). A transparent PNG at the size given in the product "pixel" field gives the best print. A public campaign gets its own page on Hoplix at the chosen url; a private one is only for the seller's own orders. Returns the campaign id.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"product_code": "<product_code>",
"product_colors": "<product_colors>",
"product_price": "<product_price>"
},
"name": "create_campaign"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public page slug: letters, digits and hyphens, must be unused (required unless private) | |
| name | Yes | Campaign name | |
| private | No | true = private campaign, only for the seller's own orders (default false) | |
| description | No | Campaign description shown on the public page (defaults to the name) | |
| product_code | Yes | Catalogue product code of the main product | |
| product_price | Yes | Selling price in EUR, VAT included; for public campaigns at least the base cost (base-cost-back when printing front and back) | |
| back_image_url | No | Public http(s) URL of the back design (PNG or JPG), only for products with two print sides | |
| product_colors | Yes | Colours of the main product, from the product colours | |
| front_image_url | No | Public http(s) URL of the front design (PNG or JPG) | |
| additional_products | No | Other products with the same design, among the additional products of the main product | |
| back_design_upload_id | No | UPL-... id of an uploaded image, used as back design (alternative to back_image_url) | |
| front_design_upload_id | No | UPL-... id of an uploaded image, used as front design (alternative to front_image_url) |