Turn PDFs into mobile flipbook catalogues: upload private drafts, customise, publish, get stats.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Confirms the address and the plan of the destination account, without secrets or payment data.
This tool takes no arguments.
Confirms the address and the plan of the destination account, without secrets or payment data.
No arguments.
{
"type": "object",
"title": "accountArguments",
"properties": {}
}Copies the styling and media of a theme of this account onto this catalogue.
| Argument | Type | Description |
|---|---|---|
| theme_id* | integer | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"title": "apply_themeArguments",
"required": [
"catalogue_id",
"theme_id",
"expected_revision"
],
"properties": {
"theme_id": {
"type": "integer",
"title": "Theme Id",
"minimum": 1
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Effective entitlements, JSON schemas and examples. Read before configuring; omitted fields are kept, null is refused. Setting changes are visible immediately on a published catalogue. Binary media, PDF replacements, API keys, REST webhooks, team and billing stay in the workspace/API.
No arguments.
{
"type": "object",
"title": "capabilitiesArguments",
"properties": {}
}Aggregated statistics: reads and contacts, without disclosing the contact details.
| Argument | Type | Description |
|---|---|---|
| days | integer | |
| catalogue_id* | string |
{
"type": "object",
"title": "catalogue_statsArguments",
"required": [
"catalogue_id"
],
"properties": {
"days": {
"type": "integer",
"title": "Days",
"default": 30,
"maximum": 3650,
"minimum": 1
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id"
}
}
}Private state: owner OAuth or guest token, never the public link alone.
| Argument | Type | Description |
|---|---|---|
| guest_token | string | |
| catalogue_id* | string |
{
"type": "object",
"title": "catalogue_statusArguments",
"required": [
"catalogue_id"
],
"properties": {
"guest_token": {
"type": "string",
"title": "Guest Token",
"default": ""
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id"
}
}
}Creates a shelf as a draft. The Distributeur plan is required; nothing is published automatically.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| patch* | any |
{
"type": "object",
"$defs": {
"ShelfPatch": {
"type": "object",
"title": "ShelfPatch",
"properties": {
"nom": {
"type": "string",
"title": "Nom",
"default": null,
"maxLength": 160,
"minLength": 1
},
"fond": {
"type": "string",
"title": "Fond",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"pied": {
"type": "string",
"title": "Pied",
"default": null,
"maxLength": 300,
"minLength": 0
},
"badge": {
"type": "boolean",
"title": "Badge",
"default": null
},
"intro": {
"type": "string",
"title": "Intro",
"default": null,
"maxLength": 2000,
"minLength": 0
},
"texte": {
"type": "string",
"title": "Texte",
"default": null,
"pattern": "^(?:|#[0-9a-fA-F]{3}|#[0-9a-fA-F]{6})$"
},
"titre": {
"type": "string",
"title": "Titre",
"default": null,
"maxLength": 240,
"minLength": 0
},
"accent": {
"type": "string",
"title": "Accent",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"layout": {
"enum": [
"grille",
"rayonnage",
"liste",
"coverflow",
"vedette",
"kiosque"
],
"type": "string",
"title": "Layout",
"default": null
},
"contact": {
"type": "string",
"title": "Contact",
"default": null,
"maxLength": 320,
"minLength": 0
},
"planche": {
"enum": [
"noyer",
"chene",
"ebene",
"verre",
"metal",
"beton",
"couleur"
],
"type": "string",
"title": "Planche",
"default": null
},
"surtitre": {
"type": "string",
"title": "Surtitre",
"default": null,
"maxLength": 160,
"minLength": 0
},
"ouverture": {
"enum": [
"page",
"onglet"
],
"type": "string",
"title": "Ouverture",
"default": null
},
"recherche": {
"type": "boolean",
"title": "Recherche",
"default": null
},
"collections": {
"type": "boolean",
"title": "Collections",
"default": null
},
"taille_couv": {
"enum": [
"petite",
"moyenne",
"grande"
],
"type": "string",
"title": "Taille Couv",
"default": null
},
"police_texte": {
"type": "string",
"title": "Police Texte",
"default": null,
"maxLength": 80,
"minLength": 0
},
"police_titre": {
"type": "string",
"title": "Police Titre",
"default": null,
"maxLength": 80,
"minLength": 0
},
"planche_couleur": {
"type": "string",
"title": "Planche Couleur",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
}
},
"additionalProperties": false
}
},
"title": "create_shelfArguments",
"required": [
"name",
"patch"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"maxLength": 160,
"minLength": 1
},
"patch": {
"$ref": "#/$defs/ShelfPatch"
}
}
}Saves the existing styling and media of the catalogue as a theme, within the limit of the plan.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"title": "create_themeArguments",
"required": [
"catalogue_id",
"name",
"expected_revision"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"maxLength": 80,
"minLength": 1
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Creates a named Business link. No email is sent; does not publish the catalogue.
| Argument | Type | Description |
|---|---|---|
| note | string | |
| string | ||
| recipient* | string | |
| catalogue_id* | string |
{
"type": "object",
"title": "create_tracking_linkArguments",
"required": [
"catalogue_id",
"recipient"
],
"properties": {
"note": {
"type": "string",
"title": "Note",
"default": "",
"maxLength": 240
},
"email": {
"type": "string",
"title": "Email",
"default": "",
"maxLength": 320
},
"recipient": {
"type": "string",
"title": "Recipient",
"maxLength": 200,
"minLength": 1
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
}Finalises an upload that has been received. A repeat returns the same catalogue, never a duplicate. Conversion is asynchronous: check foliade_catalogue_status before giving the final result. The catalogue stays private until it is published explicitly.
| Argument | Type | Description |
|---|---|---|
| upload_id* | string | |
| guest_token | string |
{
"type": "object",
"title": "finalize_uploadArguments",
"required": [
"upload_id"
],
"properties": {
"upload_id": {
"type": "string",
"title": "Upload Id"
},
"guest_token": {
"type": "string",
"title": "Guest Token",
"default": ""
}
}
}Brand name, colour and default PDF download; without any billing information.
No arguments.
{
"type": "object",
"title": "get_brandArguments",
"properties": {}
}Settings, table of contents, lead capture, protection without secrets, and the revision needed for changes.
| Argument | Type | Description |
|---|---|---|
| catalogue_id* | string |
{
"type": "object",
"title": "get_catalogue_settingsArguments",
"required": [
"catalogue_id"
],
"properties": {
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
}Elements, published version, differences and revision. The files remain those of the catalogue.
| Argument | Type | Description |
|---|---|---|
| catalogue_id* | string |
{
"type": "object",
"title": "get_enrichmentsArguments",
"required": [
"catalogue_id"
],
"properties": {
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
}Settings, catalogues in order, and revision of the shelf.
| Argument | Type | Description |
|---|---|---|
| shelf_id* | string |
{
"type": "object",
"title": "get_shelfArguments",
"required": [
"shelf_id"
],
"properties": {
"shelf_id": {
"type": "string",
"title": "Shelf Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
}Merges the PDF bookmarks into the table of contents without duplicates.
| Argument | Type | Description |
|---|---|---|
| dry_run | boolean | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"title": "import_chaptersArguments",
"required": [
"catalogue_id",
"expected_revision"
],
"properties": {
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Fetches a PDF that is already online and prepares it as a private draft. Use this when the user gives a link, or when your host hands you an attachment as a download URL rather than a local file. For a file on the user's machine, use foliade_prepare_upload instead. Only public https links are accepted, and the server checks that the link really returns a PDF. Call foliade_finalize_upload next with the upload_id.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| title | string | |
| language | string | |
| guest_mode | boolean | |
| notice_version | string |
{
"type": "object",
"title": "import_pdf_urlArguments",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url",
"maxLength": 2048,
"minLength": 8
},
"title": {
"type": "string",
"title": "Title",
"default": "",
"maxLength": 240
},
"language": {
"type": "string",
"title": "Language",
"default": "fr",
"maxLength": 5
},
"guest_mode": {
"type": "boolean",
"title": "Guest Mode",
"default": false
},
"notice_version": {
"type": "string",
"title": "Notice Version",
"default": ""
}
}
}Lists the private and public catalogues of the connected account, with pagination.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer |
{
"type": "object",
"title": "list_cataloguesArguments",
"properties": {
"limit": {
"type": "integer",
"title": "Limit",
"default": 25,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"minimum": 0
}
}
}Paginated list of the shelves and their settings, without passwords.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer |
{
"type": "object",
"title": "list_shelvesArguments",
"properties": {
"limit": {
"type": "integer",
"title": "Limit",
"default": 25,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"minimum": 0
}
}
}Account themes, their settings and revisions; a theme is a copy, not a live link.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer |
{
"type": "object",
"title": "list_themesArguments",
"properties": {
"limit": {
"type": "integer",
"title": "Limit",
"default": 25,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"minimum": 0
}
}
}Named links of the catalogue owned by the account. Contains the recipients; do not disclose them publicly.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer | |
| catalogue_id* | string |
{
"type": "object",
"title": "list_tracking_linksArguments",
"required": [
"catalogue_id"
],
"properties": {
"limit": {
"type": "integer",
"title": "Limit",
"default": 25,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"minimum": 0
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
}Creates a single-use 10-minute deposit. Compute the size and the SHA-256 of the local PDF. Transfer the bytes to upload_url with PUT, Content-Type application/pdf, with the headers returned. Do not publish these headers in your reply. This ticket allows no reading and is not an API key for the account.
| Argument | Type | Description |
|---|---|---|
| title | string | |
| sha256* | string | |
| filename* | string | |
| language | string | |
| guest_mode | boolean | |
| size_bytes* | integer | |
| notice_version | string |
{
"type": "object",
"title": "prepare_uploadArguments",
"required": [
"filename",
"size_bytes",
"sha256"
],
"properties": {
"title": {
"type": "string",
"title": "Title",
"default": "",
"maxLength": 240
},
"sha256": {
"type": "string",
"title": "Sha256",
"pattern": "^[a-fA-F0-9]{64}$"
},
"filename": {
"type": "string",
"title": "Filename",
"maxLength": 240,
"minLength": 1
},
"language": {
"type": "string",
"title": "Language",
"default": "fr",
"maxLength": 5
},
"guest_mode": {
"type": "boolean",
"title": "Guest Mode",
"default": false
},
"size_bytes": {
"type": "integer",
"title": "Size Bytes",
"minimum": 1
},
"notice_version": {
"type": "string",
"title": "Notice Version",
"default": ""
}
}
}Makes the catalogue public, on explicit request only. Keeps its identifier. It does not change the password or the addresses: those belong to foliade_set_catalogue_access.
| Argument | Type | Description |
|---|---|---|
| guest_token | string | |
| catalogue_id* | string |
{
"type": "object",
"title": "publish_catalogueArguments",
"required": [
"catalogue_id"
],
"properties": {
"guest_token": {
"type": "string",
"title": "Guest Token",
"default": ""
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id"
}
}
}Publishes the interactive elements explicitly, with history. Does not publish the catalogue itself.
| Argument | Type | Description |
|---|---|---|
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"title": "publish_enrichmentsArguments",
"required": [
"catalogue_id",
"expected_revision"
],
"properties": {
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Restores a version of this catalogue after re-checking the plan; creates a new history entry.
| Argument | Type | Description |
|---|---|---|
| catalogue_id* | string | |
| publication_id* | integer | |
| expected_revision* | string |
{
"type": "object",
"title": "restore_enrichmentsArguments",
"required": [
"catalogue_id",
"publication_id",
"expected_revision"
],
"properties": {
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"publication_id": {
"type": "integer",
"title": "Publication Id",
"minimum": 1
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Changes access on explicit request only. Never publishes a draft. The password is never returned. This tool sets the password and the addresses; to make a draft public, use foliade_publish_catalogue. Declaring a domain does not configure DNS/TLS; activation remains a separate operation.
| Argument | Type | Description |
|---|---|---|
| domaine | any | |
| dry_run | boolean | |
| password | string | |
| protection | string | |
| catalogue_id* | string | |
| sous_domaine | any | |
| expected_revision* | string |
{
"type": "object",
"title": "set_catalogue_accessArguments",
"required": [
"catalogue_id",
"expected_revision"
],
"properties": {
"domaine": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "Domaine",
"default": null
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"password": {
"type": "string",
"title": "Password",
"default": "",
"maxLength": 128
},
"protection": {
"enum": [
"keep",
"none",
"password"
],
"type": "string",
"title": "Protection",
"default": "keep"
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"sous_domaine": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Sous Domaine",
"default": null
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Replaces the table of contents with the ordered list supplied; an empty list removes it. Only the table of contents: every other reader setting stays with foliade_update_catalogue.
| Argument | Type | Description |
|---|---|---|
| dry_run | boolean | |
| chapters* | array | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"Chapter": {
"type": "object",
"title": "Chapter",
"required": [
"titre",
"page"
],
"properties": {
"page": {
"type": "integer",
"title": "Page",
"minimum": 1
},
"titre": {
"type": "string",
"title": "Titre",
"maxLength": 120,
"minLength": 1
}
},
"additionalProperties": false
}
},
"title": "set_chaptersArguments",
"required": [
"catalogue_id",
"chapters",
"expected_revision"
],
"properties": {
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"chapters": {
"type": "array",
"items": {
"$ref": "#/$defs/Chapter"
},
"title": "Chapters",
"maxItems": 300
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Sets activation, page, blocking mode, fields and consent. A plan with lead capture is required; email is mandatory.
| Argument | Type | Description |
|---|---|---|
| patch* | any | |
| dry_run | boolean | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"LeadPatch": {
"type": "object",
"title": "LeadPatch",
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": null,
"maximum": 100000,
"minimum": 1
},
"actif": {
"type": "boolean",
"title": "Actif",
"default": null
},
"champs": {
"type": "array",
"items": {
"enum": [
"email",
"nom",
"societe",
"telephone"
],
"type": "string"
},
"title": "Champs",
"default": null,
"maxItems": 4
},
"bloquant": {
"type": "boolean",
"title": "Bloquant",
"default": null
},
"consentement": {
"type": "string",
"title": "Consentement",
"default": null,
"maxLength": 4000,
"minLength": 1
}
},
"additionalProperties": false
}
},
"title": "set_lead_captureArguments",
"required": [
"catalogue_id",
"patch",
"expected_revision"
],
"properties": {
"patch": {
"$ref": "#/$defs/LeadPatch"
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Publication and access of the shelf on explicit request only; DNS/TLS remain separate.
| Argument | Type | Description |
|---|---|---|
| state | string | |
| domaine | any | |
| dry_run | boolean | |
| password | string | |
| shelf_id* | string | |
| protection | string | |
| sous_domaine | any | |
| expected_revision* | string |
{
"type": "object",
"title": "set_shelf_accessArguments",
"required": [
"shelf_id",
"expected_revision"
],
"properties": {
"state": {
"enum": [
"keep",
"brouillon",
"public",
"protege"
],
"type": "string",
"title": "State",
"default": "keep"
},
"domaine": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "Domaine",
"default": null
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"password": {
"type": "string",
"title": "Password",
"default": "",
"maxLength": 128
},
"shelf_id": {
"type": "string",
"title": "Shelf Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"protection": {
"enum": [
"keep",
"none",
"password"
],
"type": "string",
"title": "Protection",
"default": "keep"
},
"sous_domaine": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Sous Domaine",
"default": null
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Replaces the contents of the shelf with this ordered list with collection names. The PDFs themselves are kept.
| Argument | Type | Description |
|---|---|---|
| items* | array | |
| dry_run | boolean | |
| shelf_id* | string | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"ShelfItem": {
"type": "object",
"title": "ShelfItem",
"required": [
"catalogue_id"
],
"properties": {
"collection": {
"type": "string",
"title": "Collection",
"default": "",
"maxLength": 80
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
},
"additionalProperties": false
}
},
"title": "set_shelf_cataloguesArguments",
"required": [
"shelf_id",
"items",
"expected_revision"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/ShelfItem"
},
"title": "Items",
"maxItems": 400
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"shelf_id": {
"type": "string",
"title": "Shelf Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Closes the public link without deleting the data. Requires an explicit request.
| Argument | Type | Description |
|---|---|---|
| guest_token | string | |
| catalogue_id* | string |
{
"type": "object",
"title": "unpublish_catalogueArguments",
"required": [
"catalogue_id"
],
"properties": {
"guest_token": {
"type": "string",
"title": "Guest Token",
"default": ""
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id"
}
}
}Account-wide impact: use it when a global customisation is asked for, prefer update_catalogue for a single PDF.
| Argument | Type | Description |
|---|---|---|
| patch* | any | |
| dry_run | boolean | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"BrandPatch": {
"type": "object",
"title": "BrandPatch",
"properties": {
"couleur": {
"type": "string",
"title": "Couleur",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"societe": {
"type": "string",
"title": "Societe",
"default": null,
"maxLength": 160,
"minLength": 0
},
"telechargement_pdf_defaut": {
"type": "boolean",
"title": "Telechargement Pdf Defaut",
"default": null
}
},
"additionalProperties": false
}
},
"title": "update_brandArguments",
"required": [
"patch",
"expected_revision"
],
"properties": {
"patch": {
"$ref": "#/$defs/BrandPatch"
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Changes only the fields supplied: colours, bar, controls, sound, reading, logo, title, language, PDF. It never touches the table of contents, which belongs to foliade_set_chapters. dry_run returns a preview without writing. No change to the publication state.
| Argument | Type | Description |
|---|---|---|
| patch* | any | |
| dry_run | boolean | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"CataloguePatch": {
"type": "object",
"title": "CataloguePatch",
"properties": {
"fond": {
"type": "string",
"title": "Fond",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"effet": {
"enum": [
"magazine",
"book",
"slide",
"cards",
"coverflow",
"single"
],
"type": "string",
"title": "Effet",
"default": null
},
"titre": {
"type": "string",
"title": "Titre",
"default": null,
"maxLength": 240,
"minLength": 1
},
"invite": {
"enum": [
"coin",
"fleches",
"survol",
"aucune"
],
"type": "string",
"title": "Invite",
"default": null
},
"langue": {
"enum": [
"fr",
"en",
"es",
"de",
"it",
"pt",
"pl",
"nl"
],
"type": "string",
"title": "Langue",
"default": null
},
"barre_ton": {
"enum": [
"sombre",
"clair"
],
"type": "string",
"title": "Barre Ton",
"default": null
},
"fond_flou": {
"type": "integer",
"title": "Fond Flou",
"default": null,
"maximum": 40,
"minimum": 0
},
"fond_type": {
"enum": [
"couleur",
"degrade",
"image"
],
"type": "string",
"title": "Fond Type",
"default": null
},
"logo_coin": {
"enum": [
"haut-gauche",
"haut-droite",
"bas-gauche",
"bas-droite"
],
"type": "string",
"title": "Logo Coin",
"default": null
},
"logo_lien": {
"type": "string",
"title": "Logo Lien",
"default": null,
"maxLength": 300,
"minLength": 0
},
"son_actif": {
"type": "boolean",
"title": "Son Actif",
"default": null
},
"barre_auto": {
"type": "boolean",
"title": "Barre Auto",
"default": null
},
"barre_fond": {
"type": "string",
"title": "Barre Fond",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"son_volume": {
"type": "integer",
"title": "Son Volume",
"default": null,
"maximum": 100,
"minimum": 0
},
"description": {
"type": "string",
"title": "Description",
"default": null,
"maxLength": 2000,
"minLength": 0
},
"disposition": {
"enum": [
"auto",
"simple",
"double"
],
"type": "string",
"title": "Disposition",
"default": null
},
"logo_taille": {
"enum": [
"petit",
"moyen",
"grand"
],
"type": "string",
"title": "Logo Taille",
"default": null
},
"page_depart": {
"type": "integer",
"title": "Page Depart",
"default": null,
"maximum": 100000,
"minimum": 1
},
"progression": {
"type": "string",
"title": "Progression",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"barre_icones": {
"type": "string",
"title": "Barre Icones",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"fond_opacite": {
"type": "integer",
"title": "Fond Opacite",
"default": null,
"maximum": 100,
"minimum": 0
},
"fond_couleur2": {
"type": "string",
"title": "Fond Couleur2",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"fond_position": {
"enum": [
"haut",
"centre",
"bas"
],
"type": "string",
"title": "Fond Position",
"default": null
},
"barre_position": {
"enum": [
"bas",
"haut"
],
"type": "string",
"title": "Barre Position",
"default": null
},
"fond_direction": {
"enum": [
"vertical",
"diagonal",
"horizontal"
],
"type": "string",
"title": "Fond Direction",
"default": null
},
"titre_sur_fond": {
"type": "boolean",
"title": "Titre Sur Fond",
"default": null
},
"surligner_liens": {
"type": "boolean",
"title": "Surligner Liens",
"default": null
},
"controles_masques": {
"type": "array",
"items": {
"enum": [
"premiere",
"zoom",
"sommaire",
"recherche",
"partager",
"imprimer",
"pleinecran",
"telecharger"
],
"type": "string"
},
"title": "Controles Masques",
"default": null,
"maxItems": 8
},
"droite_vers_gauche": {
"type": "boolean",
"title": "Droite Vers Gauche",
"default": null
},
"telechargement_pdf": {
"enum": [
"heriter",
"autoriser",
"interdire"
],
"type": "string",
"title": "Telechargement Pdf",
"default": null
}
},
"additionalProperties": false
}
},
"title": "update_catalogueArguments",
"required": [
"catalogue_id",
"patch",
"expected_revision"
],
"properties": {
"patch": {
"$ref": "#/$defs/CataloguePatch"
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Replaces the draft: 13 types, links, buttons, videos, forms, products, galleries, tours, questions. No element that is invalid or closed off by the plan is accepted. Nothing is published before publish_enrichments. See capabilities and get_enrichments for the examples and the native structure.
| Argument | Type | Description |
|---|---|---|
| dry_run | boolean | |
| elements* | array | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"title": "update_enrichmentsArguments",
"required": [
"catalogue_id",
"elements",
"expected_revision"
],
"properties": {
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"elements": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"title": "Elements",
"maxItems": 400
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Texts, six layouts, covers, shelf boards, colours, fonts, collections, search and opening.
| Argument | Type | Description |
|---|---|---|
| patch* | any | |
| dry_run | boolean | |
| shelf_id* | string | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"ShelfPatch": {
"type": "object",
"title": "ShelfPatch",
"properties": {
"nom": {
"type": "string",
"title": "Nom",
"default": null,
"maxLength": 160,
"minLength": 1
},
"fond": {
"type": "string",
"title": "Fond",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"pied": {
"type": "string",
"title": "Pied",
"default": null,
"maxLength": 300,
"minLength": 0
},
"badge": {
"type": "boolean",
"title": "Badge",
"default": null
},
"intro": {
"type": "string",
"title": "Intro",
"default": null,
"maxLength": 2000,
"minLength": 0
},
"texte": {
"type": "string",
"title": "Texte",
"default": null,
"pattern": "^(?:|#[0-9a-fA-F]{3}|#[0-9a-fA-F]{6})$"
},
"titre": {
"type": "string",
"title": "Titre",
"default": null,
"maxLength": 240,
"minLength": 0
},
"accent": {
"type": "string",
"title": "Accent",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"layout": {
"enum": [
"grille",
"rayonnage",
"liste",
"coverflow",
"vedette",
"kiosque"
],
"type": "string",
"title": "Layout",
"default": null
},
"contact": {
"type": "string",
"title": "Contact",
"default": null,
"maxLength": 320,
"minLength": 0
},
"planche": {
"enum": [
"noyer",
"chene",
"ebene",
"verre",
"metal",
"beton",
"couleur"
],
"type": "string",
"title": "Planche",
"default": null
},
"surtitre": {
"type": "string",
"title": "Surtitre",
"default": null,
"maxLength": 160,
"minLength": 0
},
"ouverture": {
"enum": [
"page",
"onglet"
],
"type": "string",
"title": "Ouverture",
"default": null
},
"recherche": {
"type": "boolean",
"title": "Recherche",
"default": null
},
"collections": {
"type": "boolean",
"title": "Collections",
"default": null
},
"taille_couv": {
"enum": [
"petite",
"moyenne",
"grande"
],
"type": "string",
"title": "Taille Couv",
"default": null
},
"police_texte": {
"type": "string",
"title": "Police Texte",
"default": null,
"maxLength": 80,
"minLength": 0
},
"police_titre": {
"type": "string",
"title": "Police Titre",
"default": null,
"maxLength": 80,
"minLength": 0
},
"planche_couleur": {
"type": "string",
"title": "Planche Couleur",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
}
},
"additionalProperties": false
}
},
"title": "update_shelfArguments",
"required": [
"shelf_id",
"patch",
"expected_revision"
],
"properties": {
"patch": {
"$ref": "#/$defs/ShelfPatch"
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"shelf_id": {
"type": "string",
"title": "Shelf Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Changes the theme for its future applications. make_default changes the starting point of new catalogues.
| Argument | Type | Description |
|---|---|---|
| name | any | |
| patch* | any | |
| dry_run | boolean | |
| theme_id* | integer | |
| make_default | boolean | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"ReaderPatch": {
"type": "object",
"title": "ReaderPatch",
"properties": {
"fond": {
"type": "string",
"title": "Fond",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"effet": {
"enum": [
"magazine",
"book",
"slide",
"cards",
"coverflow",
"single"
],
"type": "string",
"title": "Effet",
"default": null
},
"invite": {
"enum": [
"coin",
"fleches",
"survol",
"aucune"
],
"type": "string",
"title": "Invite",
"default": null
},
"barre_ton": {
"enum": [
"sombre",
"clair"
],
"type": "string",
"title": "Barre Ton",
"default": null
},
"fond_flou": {
"type": "integer",
"title": "Fond Flou",
"default": null,
"maximum": 40,
"minimum": 0
},
"fond_type": {
"enum": [
"couleur",
"degrade",
"image"
],
"type": "string",
"title": "Fond Type",
"default": null
},
"logo_coin": {
"enum": [
"haut-gauche",
"haut-droite",
"bas-gauche",
"bas-droite"
],
"type": "string",
"title": "Logo Coin",
"default": null
},
"logo_lien": {
"type": "string",
"title": "Logo Lien",
"default": null,
"maxLength": 300,
"minLength": 0
},
"son_actif": {
"type": "boolean",
"title": "Son Actif",
"default": null
},
"barre_auto": {
"type": "boolean",
"title": "Barre Auto",
"default": null
},
"barre_fond": {
"type": "string",
"title": "Barre Fond",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"son_volume": {
"type": "integer",
"title": "Son Volume",
"default": null,
"maximum": 100,
"minimum": 0
},
"disposition": {
"enum": [
"auto",
"simple",
"double"
],
"type": "string",
"title": "Disposition",
"default": null
},
"logo_taille": {
"enum": [
"petit",
"moyen",
"grand"
],
"type": "string",
"title": "Logo Taille",
"default": null
},
"progression": {
"type": "string",
"title": "Progression",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"barre_icones": {
"type": "string",
"title": "Barre Icones",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"fond_opacite": {
"type": "integer",
"title": "Fond Opacite",
"default": null,
"maximum": 100,
"minimum": 0
},
"fond_couleur2": {
"type": "string",
"title": "Fond Couleur2",
"default": null,
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"fond_position": {
"enum": [
"haut",
"centre",
"bas"
],
"type": "string",
"title": "Fond Position",
"default": null
},
"barre_position": {
"enum": [
"bas",
"haut"
],
"type": "string",
"title": "Barre Position",
"default": null
},
"fond_direction": {
"enum": [
"vertical",
"diagonal",
"horizontal"
],
"type": "string",
"title": "Fond Direction",
"default": null
},
"titre_sur_fond": {
"type": "boolean",
"title": "Titre Sur Fond",
"default": null
},
"surligner_liens": {
"type": "boolean",
"title": "Surligner Liens",
"default": null
},
"controles_masques": {
"type": "array",
"items": {
"enum": [
"premiere",
"zoom",
"sommaire",
"recherche",
"partager",
"imprimer",
"pleinecran",
"telecharger"
],
"type": "string"
},
"title": "Controles Masques",
"default": null,
"maxItems": 8
}
},
"additionalProperties": false
}
},
"title": "update_themeArguments",
"required": [
"theme_id",
"patch",
"expected_revision"
],
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 80,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Name",
"default": null
},
"patch": {
"$ref": "#/$defs/ReaderPatch"
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"theme_id": {
"type": "integer",
"title": "Theme Id",
"minimum": 1
},
"make_default": {
"type": "boolean",
"title": "Make Default",
"default": false
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}Changes recipient, note, email or active flag; closing is explicit and reversible, with no message sent.
| Argument | Type | Description |
|---|---|---|
| patch* | any | |
| dry_run | boolean | |
| link_id* | integer | |
| catalogue_id* | string | |
| expected_revision* | string |
{
"type": "object",
"$defs": {
"LinkPatch": {
"type": "object",
"title": "LinkPatch",
"properties": {
"note": {
"type": "string",
"title": "Note",
"default": null,
"maxLength": 240
},
"actif": {
"type": "boolean",
"title": "Actif",
"default": null
},
"email": {
"type": "string",
"title": "Email",
"default": null,
"maxLength": 320
},
"destinataire": {
"type": "string",
"title": "Destinataire",
"default": null,
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
},
"title": "update_tracking_linkArguments",
"required": [
"catalogue_id",
"link_id",
"patch",
"expected_revision"
],
"properties": {
"patch": {
"$ref": "#/$defs/LinkPatch"
},
"dry_run": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"link_id": {
"type": "integer",
"title": "Link Id",
"minimum": 1
},
"catalogue_id": {
"type": "string",
"title": "Catalogue Id",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"expected_revision": {
"type": "string",
"title": "Expected Revision",
"pattern": "^[a-f0-9]{64}$"
}
}
}