# Unisoft — תיעוד מלא **גרסאות API** · [V2 (Latest)](/integrations/v2/docs?lang=he) · **V1** > **גרסה זו של ה־API מיושנת.** לחיבורים חדשים יש להשתמש בגרסה העדכנית ביותר. [לתיעוד העדכני](/integrations/v2/docs?lang=he) ## הקריאה הראשונה שלכם התחילו בקריאת נתונים כדי לבדוק את החיבור לפני ביצוע כתיבה כלשהי. ### 1. הכנת המפתח בממשק הניהול של Unisoft, פתחו את ״מפתחים״, צרו מפתח API והעניקו לו רק את ההרשאות הדרושות לאינטגרציה שלכם. העתיקו את המפתח בעת יצירתו. ### 2. בחירת הסביבה המתאימה לסביבות הייצור והפיתוח יש שמות מתחם נפרדים. השתמשו במפתח שנוצר בסביבה שאליה אתם פונים. ```shell PRODUCTION=https://api.unisoft.world/integrations/v1 DEVELOPMENT=https://kehilaapi.syn-assist.fr/integrations/v1 ``` ### 3. בדיקת החיבור ```shell export UNISOFT_API_URL='https://api.unisoft.world/integrations/v1' export UNISOFT_API_KEY='ke_live_REPLACE_WITH_YOUR_KEY' curl --fail-with-body "$UNISOFT_API_URL/me" \ --header "Authorization: Bearer $UNISOFT_API_KEY" ``` GET /me מחזירה את הארגון, את הרשאות המפתח ואת השפות שהופעלו. בדקו את המידע הזה לפני שתמשיכו. ### דוגמה ```json { "success": true, "data": { "apiKey": { "id": "key_example", "name": "Example integration", "prefix": "ke_live_", "scopes": [ "contacts:read" ] }, "organisation": { "id": "org_example", "name": "Example organisation", "shortName": "Example", "defaultLanguage": "fr", "enabledLanguages": [ "fr", "en" ] } } } ``` ### 4. קריאת אנשי הקשר הראשונים שלכם לקריאה זו נדרשת ההרשאה contacts:read. פרמטרי החיפוש הזמינים מפורטים בתיעוד ה-API. ```shell curl --fail-with-body "$UNISOFT_API_URL/contacts?limit=10" \ --header "Authorization: Bearer $UNISOFT_API_KEY" ``` ## אימות מפתח אחד, תחום גישה מוגדר והרשאות מפורשות. שלחו את המפתח בכותרת Authorization: Bearer או X-API-Key. לעולם אל תכללו אותו בכתובת URL או בקוד ציבורי של אתר. ```shell Authorization: Bearer ke_live_REPLACE_WITH_YOUR_KEY ``` המפתח ke_live_ משויך לארגון אחד בלבד. הרשאות קריאה, כתיבה ושליחה נפרדות זו מזו. בכל פעולה מצוינות ההרשאות שהיא מקבלת. ### הבנת שגיאה 401 MISSING_API_KEY או INVALID_API_KEY: בדקו את המפתח, הכותרת והסביבה. 403 INSUFFICIENT_SCOPE: בדקו את ההרשאות הנדרשות לפעולה. שגיאות עסקיות אחרות מתועדות לכל פעולה בנפרד. שמרו את קוד ה-HTTP ואת השדה error כדי לאבחן כשל. אם פג זמן ההמתנה במהלך כתיבה או שליחה, בדקו את התוצאה לפני ניסיון חוזר: לא כל הפעולות אידמפוטנטיות. ## נתונים ועימוד כללים שכדאי לבדוק לפני קריאה או שינוי של הנתונים שלכם. ### מעבר על רשימה רשימות עם עימוד כוללות את data ואת meta. כל עוד meta.hasMore הוא true, הציבו את meta.nextCursor בפרמטר cursor ושמרו על אותם מסננים. המגבלה הרגילה היא 50 פריטים, והמקסימום הוא 200; בדקו את הפרמטרים של כל פעולה. ```shell GET /contacts?limit=50 GET /contacts?limit=50&cursor=NEXT_CURSOR ``` ### סכומים ומטבעות סכומי התשלומים מבוטאים ביחידות הקטנות של המטבע: 1500 מייצג 15,00 EUR. התחייבויות לתרומה משתמשות ביחידות מלאות. בדקו תמיד את סכמת השדה ואת המטבע שלו. ### עריכת תוכן רב-לשוני שפת הארגון הראשית נמצאת ברמה העליונה של האובייקט. השפות האחרות מופיעות כאובייקטים חלקיים תחת קוד השפה שלהן. בדקו את defaultLanguage ואת enabledLanguages באמצעות GET /me. ```json { "label": "Restaurant", "en": {"label": "Restaurant"}, "he": {"label": "מסעדה"} } ``` בבקשת PATCH, שדה שלא נשלח נשאר ללא שינוי. הצבת שכבת שפה על null מוחקת את התרגום הזה. כללי המחיקה של שדות אחרים תלויים בסכמה שלהם. **Multilingual content (read this before writing any text field).** Translatable content does NOT use a `{fr:…, en:…}` map. Instead: - The value in the organisation's **default language** (`org.language`) sits at the **ROOT** of the object — never nested under its own language key. - Every **other** language enabled by the org (`org.languages`) is a **partial overlay** keyed by its language code, holding only the translatable fields. ```json { "label": "Restaurant", "he": { "label": "מסעדה" } } // org default = French ``` Valid overlay keys are **dynamic per organisation** = its enabled languages minus the default one. Sending the default language as an overlay is rejected (it would duplicate the root); an unsupported language is dropped silently. A field missing from an overlay falls back to the root value. **Editing vs deleting a translation** — on a partial update (`PATCH`), omitting a key means *"leave it as it is"*. Therefore: | Body | Effect on the `he` translation | |---|---| | `{"he": {"label": "מסעדה"}}` | created / overwritten | | *(key omitted)* | left untouched | | `{"he": null}` | **deleted** (the whole `he` overlay is removed) | | `{"he": {}}` | deleted too — an empty overlay carries no translation | To delete a translation, explicitly send null for that language. An empty translation object is also treated as a deletion; omitting the language preserves its current value. **The default language is gated on the operation, not on the key.** Sending it as an overlay to WRITE it is rejected (`{"fr": {"label": "…"}}` on a French-default org) — the default language belongs at the root. But `{"fr": null}` is accepted: it DELETES an overlay in that language. This matters when an organisation changes its default language — an overlay in the new default language survives in the documents and takes precedence over the root value when rendered, so deleting it must remain possible. See the `I18nOverlay` schema. ## קבלת Webhooks קבלו אירועים של Unisoft בשרת שלכם ואמתו את החתימה שלהם. במסך ״מפתחים״, הגדירו כתובת יעד מסוג HTTPS ובחרו אילו אירועים לקבל. שמרו את הסוד שמוצג בעת היצירה או החלפת הסוד. אמתו את חתימת HMAC SHA-256 מול גוף הבקשה הגולמי וחותמת הזמן, לפני קריאת ה-JSON. שמרו את האירוע לפני החזרת סטטוס 2xx, ואז עבדו עליו באופן אסינכרוני. ```shell signed_payload = X-Unisoft-Timestamp + "." + raw_body expected_signature = "sha256=" + HMAC_SHA256_HEX(secret, signed_payload) ``` השתמשו במזהה האירוע כדי למנוע עיבוד כפול. משלוחים עשויים לחזור או להגיע בסדר שונה. הפורמטים, הדוגמאות, הכותרות וכללי הניסיון החוזר מפורטים בחוזה ה-Webhooks שלהלן וב-x-webhooks בקובץ OpenAPI. ### Payment webhooks Unisoft sends an HTTP POST with Content-Type: application/json to the HTTPS URL configured in Developers > Outbound webhooks. The integration secret is shown once at creation/rotation; no API key is sent to your endpoint. Verify X-Unisoft-Signature against "sha256=" + hex(HMAC-SHA256(secret, X-Unisoft-Timestamp + "." + rawBody)). Use the exact raw request bytes, BEFORE parsing JSON (Firebase HTTPS functions expose req.rawBody). Use a timing-safe comparison and reject non-numeric or stale timestamps; recommended tolerance is 300 seconds. The timestamp is Unix seconds and is refreshed for each attempt. Acknowledge with any 2xx response within 10 seconds; the response body is ignored. Persist/enqueue the event before acknowledging, then process asynchronously. Deduplicate by the envelope id (also X-Unisoft-Event-Id); it stays stable across delivery retries, while attempt increases. createdAt is the enqueue date, not necessarily the payment datetime. Deliveries may be duplicated or arrive out of order. Network errors, timeouts, 5xx, 408 and 429 are retried, up to 6 attempts. Other 4xx are terminal. After 20 consecutive integration failures the destination is quarantined for 24 hours. This is not an unlimited delivery guarantee; reconcile with GET /paiements when needed. Payment data is a snapshot of the payment at emission, not a normalized bank event. amount is in minor units, devise is the currency, contact is a contact ID (not a contact object), and info holds donor identity. Additional fields vary by provider/type. externalRef and externalMetadata are included when present; old payments may omit them. Do not rely on provider-specific fields. These payloads can contain personal data. #### paiement.success / paiement.refunded Subscribe to paiement.success for completed payments and paiement.refunded for confirmed refunds. Refund notifications contain the original payment with its updated refund state; amount remains the original payment amount. The synchronous refund API response is a different object. Example paiement.success (representative fields; provider-specific fields may also be present): ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.success", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "COMPLETED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" } } } ``` Example paiement.refunded (representative fields; provider-specific fields may also be present): ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.refunded", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "REFUNDED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "refund": { "state": "SUCCEEDED", "reason": "requested_by_customer", "updatedAt": "2026-10-16T11:00:00.000Z" } } } ``` #### Headers | Header | Meaning | |---|---| | X-Unisoft-Event | Same as body.type | | X-Unisoft-Event-Id | Same as body.id; deduplication key | | X-Unisoft-Delivery-Id | Delivery record ID for this destination | | X-Unisoft-Timestamp | Unix seconds | | X-Unisoft-Signature | sha256= followed by the lowercase hex HMAC | #### Connectivity test The backoffice Test button sends webhook.test through the normal signed queue, regardless of the subscription event list. It creates no payment or refund. Its data contains test:true, triggeredBy (admin access ID or null) and message. Event-specific machine-readable schemas are also available under x-webhooks in openapi.json. ## חיבור עוזר AI MCP חושף כלים ואת תהליכי העבודה העסקיים שלהם ללקוחות תואמים. ```shell https://api.unisoft.world/integrations/mcp ``` הפעילו את MCP במסך ״מפתחים״ ואז חברו את הלקוח התואם שלכם. עדיין נדרשים אישור הגישה וההרשאות של הארגון. MCP מפרסם חמישה skills עסקיים. הלקוח יכול לטעון ישירות את תהליך העבודה הדרוש, ללא הורדה נפרדת. המניפסט מפרט גם את הקבצים הזמינים. לעוזר שקורא קבצים, השתמשו באינדקס llms.txt או בקובצי הייצוא של Markdown. הם מתעדים את ה-API ואינם מעניקים גישה נוספת. ## Unisoft — Integrations API OpenAPI 3.0.3 · API 1.0.0 ```json [ { "url": "https://api.unisoft.world/integrations/v1", "description": "API" } ] ``` Unisoft integration API for no-code tools (Make, n8n, Zapier) and AI agents (via the MCP server). **Two mechanisms:** 1. **Action endpoints** documented below — read access to contacts, payments and subscriptions; full management of **forms** (definitions + submissions, incl. accept/refuse), **caisses** (« cagnottes »), and **tourism (Travel) sites** (config + places). See the per-section tags. 2. **Outbound webhooks** — Unisoft notifies a configured URL on every business event (`paiement.success`, `paiement.refunded`, `form.submitted`, `contact.created`). Payment payloads, examples, signature headers and delivery rules are described in the `x-webhooks` vendor extension of this spec (the root `webhooks` keyword is OAS 3.1-only; this spec is 3.0). **Auth:** header `Authorization: Bearer ke_live_xxx` or `X-API-Key: ke_live_xxx`. Keys are generated in `Settings > Developers` in the Unisoft backoffice. The global email-template authoring endpoints are the only exception: they require the organisation-less `kc_live_*` token configured in `EMAIL_TEMPLATE_CATALOG_TOKEN`. Their smaller standalone specification is available at `/integrations/v1/email-template-catalog/openapi.json`. **Pagination:** cursor-based. Response `{data: [...], meta: {nextCursor, hasMore}}`. For the next page, add `?cursor=`. **Tenant isolation:** every regular `ke_live_*` key is tied to one organisation. All of its responses are scoped to that org. The `kc_live_*` catalogue token has no organisation and can access only global catalogue-authoring operations. ### Payment webhooks Unisoft sends an HTTP POST with Content-Type: application/json to the HTTPS URL configured in Developers > Outbound webhooks. The integration secret is shown once at creation/rotation; no API key is sent to your endpoint. Verify X-Unisoft-Signature against "sha256=" + hex(HMAC-SHA256(secret, X-Unisoft-Timestamp + "." + rawBody)). Use the exact raw request bytes, BEFORE parsing JSON (Firebase HTTPS functions expose req.rawBody). Use a timing-safe comparison and reject non-numeric or stale timestamps; recommended tolerance is 300 seconds. The timestamp is Unix seconds and is refreshed for each attempt. Acknowledge with any 2xx response within 10 seconds; the response body is ignored. Persist/enqueue the event before acknowledging, then process asynchronously. Deduplicate by the envelope id (also X-Unisoft-Event-Id); it stays stable across delivery retries, while attempt increases. createdAt is the enqueue date, not necessarily the payment datetime. Deliveries may be duplicated or arrive out of order. Network errors, timeouts, 5xx, 408 and 429 are retried, up to 6 attempts. Other 4xx are terminal. After 20 consecutive integration failures the destination is quarantined for 24 hours. This is not an unlimited delivery guarantee; reconcile with GET /paiements when needed. Payment data is a snapshot of the payment at emission, not a normalized bank event. amount is in minor units, devise is the currency, contact is a contact ID (not a contact object), and info holds donor identity. Additional fields vary by provider/type. externalRef and externalMetadata are included when present; old payments may omit them. Do not rely on provider-specific fields. These payloads can contain personal data. #### paiement.success / paiement.refunded Subscribe to paiement.success for completed payments and paiement.refunded for confirmed refunds. Refund notifications contain the original payment with its updated refund state; amount remains the original payment amount. The synchronous refund API response is a different object. Example paiement.success (representative fields; provider-specific fields may also be present): ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.success", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "COMPLETED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" } } } ``` Example paiement.refunded (representative fields; provider-specific fields may also be present): ```json { "id": "800efee9-9414-4392-98d0-2ebf6759f617", "type": "paiement.refunded", "organisation": "org_example", "createdAt": "2026-10-16T11:00:00.000Z", "attempt": 1, "data": { "id": "cf161b09-6bab-4a24-9c7b-c8f223b18c09", "organisation": "org_example", "name": "Donation", "state": "REFUNDED", "type": "GENERAL", "platform": "STRIPE", "method": "CB", "amount": 1500, "devise": "eur", "contact": "contact_example", "info": { "prenom": "Sarah", "nom": "Cohen", "email": "sarah@example.org", "tel": "" }, "datetime": "2026-10-16T10:00:00.000Z", "externalRef": "commande-1234", "externalMetadata": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "refund": { "state": "SUCCEEDED", "reason": "requested_by_customer", "updatedAt": "2026-10-16T11:00:00.000Z" } } } ``` #### Headers | Header | Meaning | |---|---| | X-Unisoft-Event | Same as body.type | | X-Unisoft-Event-Id | Same as body.id; deduplication key | | X-Unisoft-Delivery-Id | Delivery record ID for this destination | | X-Unisoft-Timestamp | Unix seconds | | X-Unisoft-Signature | sha256= followed by the lowercase hex HMAC | #### Connectivity test The backoffice Test button sends webhook.test through the normal signed queue, regardless of the subscription event list. It creates no payment or refund. Its data contains test:true, triggeredBy (admin access ID or null) and message. Event-specific machine-readable schemas are also available under x-webhooks in openapi.json. **Multilingual content (read this before writing any text field).** Translatable content does NOT use a `{fr:…, en:…}` map. Instead: - The value in the organisation's **default language** (`org.language`) sits at the **ROOT** of the object — never nested under its own language key. - Every **other** language enabled by the org (`org.languages`) is a **partial overlay** keyed by its language code, holding only the translatable fields. ```json { "label": "Restaurant", "he": { "label": "מסעדה" } } // org default = French ``` Valid overlay keys are **dynamic per organisation** = its enabled languages minus the default one. Sending the default language as an overlay is rejected (it would duplicate the root); an unsupported language is dropped silently. A field missing from an overlay falls back to the root value. **Editing vs deleting a translation** — on a partial update (`PATCH`), omitting a key means *"leave it as it is"*. Therefore: | Body | Effect on the `he` translation | |---|---| | `{"he": {"label": "מסעדה"}}` | created / overwritten | | *(key omitted)* | left untouched | | `{"he": null}` | **deleted** (the whole `he` overlay is removed) | | `{"he": {}}` | deleted too — an empty overlay carries no translation | To delete a translation, explicitly send null for that language. An empty translation object is also treated as a deletion; omitting the language preserves its current value. **The default language is gated on the operation, not on the key.** Sending it as an overlay to WRITE it is rejected (`{"fr": {"label": "…"}}` on a French-default org) — the default language belongs at the root. But `{"fr": null}` is accepted: it DELETES an overlay in that language. This matters when an organisation changes its default language — an overlay in the new default language survives in the documents and takes precedence over the root value when rendered, so deleting it must remain possible. See the `I18nOverlay` schema. ### פעולות ### GET /utils/uuid Generate a UUID `generate_uuid` Generate one or more v4 UUIDs. Most resource ids in this API are UUIDs, so an integration (or an MCP/AI agent) often needs a fresh, valid id before creating or linking a resource (e.g. choose a content-block id, then write it). No scope required — any valid key passes. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": null, "additional": [] } ``` #### פרמטרים ```json { "name": "count", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 1 }, "description": "How many UUIDs to generate (1–100). Default 1." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "The first generated UUID (convenience for the common count=1 case)." }, "uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "All generated UUIDs." } } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /me Information about the current API key `get_me` Read the calling key's identity, granted scopes and organisation, including defaultLanguage and enabledLanguages. Use this read-only endpoint to check the key and environment before any write. Requires a valid organisation API key; no additional scope is required. The global kc_live_* catalogue token cannot call this endpoint. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": null, "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "organisation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "defaultLanguage": { "type": "string", "description": "Language stored at the root of multilingual business objects." }, "enabledLanguages": { "type": "array", "items": { "type": "string" }, "description": "All enabled languages, including defaultLanguage. Other languages are written as partial overlays." } } } } } } } } } } ``` ##### HTTP 401 ```json { "description": "Missing or invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /contacts List contacts `list_contacts` Required scope: `contacts:read`. Lists/filters the org's contacts, each returned in the rich shape (identity + sub-collections). `email`/`phone` here are EXACT scalar matches (for a fuzzy dedup lookup use GET /contacts/search instead). Paginated. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "createdAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter: created after this date (ISO 8601)" } ``` ```json { "name": "updatedAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Only contacts edited after this date." } ``` ```json { "name": "email", "in": "query", "schema": { "type": "string" }, "description": "Exact (lower-cased) primary-email match." } ``` ```json { "name": "phone", "in": "query", "schema": { "type": "string" }, "description": "Exact primary-phone match." } ``` ```json { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Filter by a category tag (normalised, e.g. \"Donateur\" → DONATEUR)." } ``` ```json { "name": "isLocal", "in": "query", "schema": { "type": "boolean" }, "description": "Filter by the « local » proximity flag (true/false)." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts Create or upsert a contact `create_contact` Required scope: `contacts:write`. INTELLIGENT UPSERT: if a contact with this `phone` or `email` (normalised) already exists, it is UPDATED fill-if-empty — existing identity values are NEVER overwritten, secondary phones/emails/addresses/tags/customFields are appended, and the response is `created:false`. Only a real insertion emits the `contact.created` webhook. Pass `?forceCreate=true` to always insert a new doc. To OVERWRITE a known identity value use PATCH /contacts/{id} instead. On a fresh create with no `tags`, the source tag `#API` is set. Formats: `gender` "M"/"F"/null (never a civility string), `phone` any format → E.164, `birthDate` ISO. `tags` are boolean labels; `customFields` are typed key/value pairs (upsert-by-key; NUMBER/DATETIME stored as TEXT). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "forceCreate", "in": "query", "schema": { "type": "boolean" }, "description": "true → always insert a new contact, even if a phone/email match exists." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreateInput" }, "example": { "firstName": "david", "lastName": "levy", "gender": "M", "email": "David.Levy@GMAIL.com ", "phone": "06 11 22 33 44", "tags": [ "Donateur" ], "customFields": [ { "key": "classe", "type": "TEXT", "value": "CM2" } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "created": { "type": "boolean", "description": "true = a new contact was inserted; false = an existing one was upserted fill-if-empty." }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/search Find a contact by tel/email (dedup) `search_contacts` Required scope: `contacts:read`. Dedup pre-create lookup: normalises `email`/`phone` and returns the single matching contact (`{found, contact}`) — NOT a paginated list. Use it before create_contact to know whether a contact already exists. Provide at least one of `email` or `phone`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### פרמטרים ```json { "name": "email", "in": "query", "schema": { "type": "string" }, "description": "Email to match (normalised)." } ``` ```json { "name": "phone", "in": "query", "schema": { "type": "string" }, "description": "Phone to match (normalised)." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "found": { "type": "boolean" }, "contact": { "oneOf": [ { "$ref": "#/components/schemas/Contact" } ], "nullable": true } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_QUERY", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_QUERY" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /contacts/import/schema Discover importable fields & options `get_contact_import_schema` Required scope: `contacts:read`. The self-describing import guide — call this FIRST to discover every importable field (with aliases to match your spreadsheet columns) and the available options, THEN normalize → lookup → import dryRun → import. Returns `fields[]` ({key, label, type, kind, multi, example, description, aliases[]}) and `options` (dedupStrategy, defaultPhoneCountry, dateFormat, requireContact, applyTags). Mirrors the admin ImportPage mapping step. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContactImportSchema" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/normalize Normalise raw spreadsheet rows (pure) `normalize_contacts` Required scope: `contacts:read`. PURE per-column normalisation of dirty spreadsheet rows — NO database, NO org data touched. For each row it cleans phone→E.164 (+ detected country), email, birthDate→ISO, and civility→`gender` "M"/"F", and flags per-row `issues`. STEP 2 of the Excel import flow (after get_contact_import_schema; then lookup_contacts, then import_contacts dryRun). Example row `{phone:"06 12 34 56 78", birthDate:"15/03/1990", gender:"Mme", firstName:"sarah", category:"Séder night"}` → `{phone:{e164:"+33612345678", country:"FR", valid:true}, birthDate:{value:"1990-03-15", valid:true}, gender:"F", firstName:"Sarah", tags:["SEDER_NIGHT"]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNormalizeInput" }, "example": { "rows": [ { "phone": "06 12 34 56 78", "birthDate": "15/03/1990", "gender": "Mme", "firstName": "sarah", "category": "Séder night" } ], "defaultPhoneCountry": "FR" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/NormalizeResult" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/lookup Batch dedup lookup (no write) `lookup_contacts` Required scope: `contacts:read`. For each item, finds the matching contact of the org WITHOUT writing anything (a soft-deleted contact is never resurrected). STEP 3 of the Excel import flow: run it after normalize_contacts to learn which rows already exist (`matchedContactId`) before importing. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactLookupInput" }, "example": { "items": [ { "phone": "+33611223344" }, { "email": "david.levy@gmail.com" } ], "defaultPhoneCountry": "FR" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/LookupResult" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/import Bulk import contacts (dry-run + real) `import_contacts` Required scope: `contacts:write`. Bulk upsert of up to 500 rows (500+ → 400 IMPORT_TOO_LARGE; paginate the file yourself). STEP 4 of the Excel flow: call with `dryRun:true` FIRST to get the per-line PLAN (`report.lines[].action` = create/update/skip/error + `issues`) WITHOUT writing anything, fix the rows flagged `error`, then re-call with `dryRun:false`. `options.dedupStrategy` = skip|update|create (default update). Example dry-run `{contacts:[{__row:2, lastName:"cohen", phone:"061122", birthDate:"32/13/1990"}], dryRun:true}` → `report.lines:[{row:2, action:"error", issues:[{field:"phone", reason:"INVALID_PHONE", severity:"error"}, {field:"birthDate", reason:"INVALID_DATE", severity:"error"}]}]`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactImportInput" }, "example": { "contacts": [ { "__row": 2, "firstName": "sarah", "lastName": "cohen", "phone": "06 12 34 56 78", "birthDate": "15/03/1990" } ], "options": { "dedupStrategy": "update", "applyTags": [ "Import 2026" ] }, "dryRun": true } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ImportResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "IMPORT_TOO_LARGE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "IMPORT_TOO_LARGE" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/{id} Get a contact `get_contact` Required scope: `contacts:read`. Returns the full rich contact (identity + addresses/secondaryPhones/secondaryEmails/tags/customFields/familyLinks). 404 (never 403) if the id belongs to another org. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /contacts/{id} Update a contact's identity (override) `update_contact` Required scope: `contacts:write`. EXPLICIT OVERRIDE of identity fields (whitelisted + re-normalisation) — unlike create_contact this REPLACES the stored value. Sub-collections (secondary phones/emails/addresses/tags/customFields) are NOT touched — use the dedicated sub-resource endpoints. An empty string ("") means « leave untouched » (append-only: identity is never erased). Invalid email/phone/birthDate → 400. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdateInput" }, "example": { "lastName": "LEVY", "gender": "M", "email": "d.levy@pro.com" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_EMAIL, INVALID_PHONE or INVALID_DATE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_EMAIL, INVALID_PHONE or INVALID_DATE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/addresses Add an address `add_contact_address` Required scope: `contacts:write`. Adds an address: the PRIMARY one if the contact has none (or `main:true`), otherwise a deduped SECONDARY address (which carries a stable id, patchable later). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAddressInput" }, "example": { "label": "Bureau", "type": "PRO", "address": "12 rue de la Paix", "postalCode": "75002", "city": "Paris" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_ADDRESS", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_ADDRESS" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### PATCH /contacts/{id}/addresses/{addressId} Edit a secondary address `update_contact_address` Required scope: `contacts:write`. Merges the supplied fields into the SECONDARY address identified by `addressId` (a UUID from `adresses[].id`). Only supplied fields change. The PRIMARY address has no id and cannot be edited here — use PATCH /contacts/{id} or POST /contacts/{id}/addresses with main:true. 404 ADDRESS_NOT_FOUND if the id is not a secondary address of this contact. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The secondary address's id (from `adresses[].id`)." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAddressPatchInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND or ADDRESS_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND or ADDRESS_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/phones Add a secondary phone `add_contact_phone` Required scope: `contacts:write`. Appends a SECONDARY phone (E164, deduped). The primary phone is set via create_contact / update_contact. 400 INVALID_PHONE if unparseable. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPhoneInput" }, "example": { "phone": "06 98 76 54 32", "phoneCountry": "FR" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_PHONE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_PHONE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/{id}/emails Add a secondary email `add_contact_email` Required scope: `contacts:write`. Appends a SECONDARY email (deduped). The primary email is set via create_contact / update_contact. 400 INVALID_EMAIL if invalid. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactEmailInput" }, "example": { "email": "perso@gmail.com" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_EMAIL", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_EMAIL" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /contacts/{id}/tags Add category tag(s) `add_contact_tags` Required scope: `contacts:write`. Adds one or more category TAGS (idempotent — re-adding is a no-op). Each is normalised (upper-cased, de-accented, spaces→`_`, e.g. "Séder night" → SEDER_NIGHT). A tag is a boolean label — NOT a key/value custom field (see POST /contacts/{id}/custom-fields). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTagsInput" }, "example": { "tags": [ "Donateur régulier", "Séder night" ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_TAGS", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_TAGS" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /contacts/{id}/tags/{tag} Remove a category tag `remove_contact_tag` Required scope: `contacts:write`. Removes ONE category tag from the contact (no-op if absent). `tag` is a free string (URL-encode `#FORM` etc.); it is normalised the same way as when added. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The category tag to remove (URL-encoded; normalised server-side)." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/custom-fields Set custom fields (upsert-by-key) `set_contact_custom_fields` Required scope: `contacts:write`. Upserts typed custom fields BY KEY (writing the same key twice updates the single field, never duplicates). `override` (default true — explicit edit) overwrites the value; false only fills empty fields. `type` is reduced to TEXT/DATE/BOOL — NUMBER/DATETIME are stored as TEXT. Custom fields are distinct from category tags. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCustomFieldsInput" }, "example": { "customFields": [ { "key": "classe", "type": "TEXT", "value": "CM2" }, { "key": "casher", "type": "BOOL", "value": true } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_CUSTOM_FIELDS", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_CUSTOM_FIELDS" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /contacts/{id}/custom-fields/{key} Remove a custom field `remove_contact_custom_field` Required scope: `contacts:write`. Removes a custom field by key (case- and separator-insensitive: `_` and `-` are equivalent). No-op if absent. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The field key to remove (URL-encoded; case/separator-insensitive)." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/family Add a family link `add_contact_family_link` Required scope: `contacts:write`. Adds a BIDIRECTIONAL family link between this contact and `relatedContactId` (the reverse link is added automatically). `relatedContactId` MUST belong to the same org (else 404 — no cross-tenant oracle). 400 UNKNOWN_RELATIONSHIP for an out-of-enum `relationship`; 400 SELF_LINK if it targets itself. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactFamilyLinkInput" }, "example": { "relationship": "PARENT", "relatedContactId": "b3f1c2d4-5678-49ab-8cde-0123456789ab" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "UNKNOWN_RELATIONSHIP or SELF_LINK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNKNOWN_RELATIONSHIP or SELF_LINK" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND or RELATED_CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND or RELATED_CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /contacts/{id}/family/{relatedContactId} Remove a family link `remove_contact_family_link` Required scope: `contacts:write`. Removes the family link (and its reverse) between this contact and `relatedContactId`. `?relationship` precises which link to remove. `relatedContactId` must belong to the org (404 otherwise). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "relatedContactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The related contact's id." } ``` ```json { "name": "relationship", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "SPOUSE", "PARENT", "CHILD", "SIBLING", "GRANDPARENT", "GRANDCHILD", "IN_LAW", "EX", "COUSIN", "FRIEND" ] }, "description": "The relationship to remove (REQUIRED — omitting it returns 400 UNKNOWN_RELATIONSHIP)." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "UNKNOWN_RELATIONSHIP", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNKNOWN_RELATIONSHIP" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND or RELATED_CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND or RELATED_CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/children Add a child `add_contact_child` Required scope: `contacts:write`. Adds a « baby » child (no phone/email) whose parents are this contact + its detected SPOUSE. Deduped by first name against the parents: an existing child is reused (`created:false`), else a new child contact is created. A PARENT↔CHILD link is set automatically. Example `{firstName:"Rivka", birthDate:"2015-09-01"}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactChildInput" }, "example": { "firstName": "Rivka", "birthDate": "2015-09-01" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "created": { "type": "boolean", "description": "false = an existing child was reused." }, "childId": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FIRST_NAME", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FIRST_NAME" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/{id}/interactions List a contact's interactions `list_contact_interactions` Required scope: `contacts:read`. Returns the logged touchpoints (calls, visits, notes) for this contact, most recent first, cursor-paginated. An interaction is a `contact_activity` entry — distinct from a custom field or a category. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInteraction" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/interactions Log an interaction `add_contact_interaction` Required scope: `contacts:write`. Records a touchpoint with the contact (a call, a visit, a note). `type` is required — reuse one from GET /contacts/{id}/interactions/types for consistency. Example `{type:"Appel", content:"Rappelé pour la campagne de Pessah", actions:["Discussion"]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInteractionInput" }, "example": { "type": "Appel", "content": "Rappelé pour la campagne de Pessah", "actions": [ "Discussion" ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContactInteraction" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_TYPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_TYPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /contacts/{id}/interactions/types List interaction types `list_contact_interaction_types` Required scope: `contacts:read`. Returns the distinct interaction `type` labels already used in the organisation (plus common defaults like « Appel », « Visite »). Pick one of these when logging an interaction so the CRM stays consistent instead of accumulating near-duplicate labels. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /contacts/{id}/documents List a contact's documents `list_contact_documents` Required scope: `contacts:read`. Files attached to the contact (receipts, ID scans, signed mandates…), most recent first. Each has an `id` (to delete it), a `name`, a hosted `filename` and a download `url`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDocument" } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /contacts/{id}/documents Attach a document `create_contact_document` Required scope: `contacts:write`. Attaches a document to the contact. « Upload first, place after »: provide EITHER a `filename` already hosted via POST /uploads/pdf|image, OR an http(s) `url` re-hosted server-side (image/PDF only). An optional `name` labels it. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDocumentInput" }, "example": { "url": "https://example.com/receipt-2026.pdf", "name": "Reçu fiscal 2026" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContactDocument" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FILE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FILE" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /contacts/{id}/documents/{docId} Detach a document `delete_contact_document` Required scope: `contacts:write`. Removes a document from the contact by its `docId` (the file itself stays hosted). 404 if the contact or the document id is unknown here. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "contacts:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "docId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Document id returned by GET /contacts/{id}/documents." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean" } } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "DOCUMENT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "DOCUMENT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "contacts:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /paiements List payments `list_paiements` Required scope: `paiements:read`. Lists only non-deleted COMPLETED or REFUNDED payments within the organisation and API-key restrictions. externalRef uses exact, case-sensitive equality and combines with the other filters; multiple payments may share it. No match returns an empty paginated list. INIT, pending and failed attempts remain excluded even with externalRef. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "paiements:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "createdAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter: created after this date (ISO 8601)" } ``` ```json { "name": "createdBefore", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter: created before this date (ISO 8601)" } ``` ```json { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "GENERAL | SERVICE | CAISSE | DETTE | FORM" } ``` ```json { "name": "platform", "in": "query", "schema": { "type": "string" }, "description": "STRIPE | PAYGREEN | ..." } ``` ```json { "name": "contactId", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "externalRef", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S", "example": "commande-1234", "description": "Optional reference in your system. Non-blank, stored verbatim; exact, case-sensitive matching. Not unique and NOT an idempotency key. Distinct from externalId (import deduplication). Returned on payment reads and payment webhooks when supplied. Recurring payments inherit it." }, "description": "Exact, case-sensitive external reference; URL-encode the value. Example: ?externalRef=commande-1234. A repeated/structured or invalid value returns 400 INVALID_EXTERNAL_REF." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Paiement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_EXTERNAL_REF", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_EXTERNAL_REF" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /paiements Create a standalone payment link `create_paiements` Required scope: `paiements:write`. Creates a payment record in INIT state and returns the hosted payment page URL (or clientSecret for embedded providers). The target entity (`typeId`) must belong to the API key's organisation. `config.organisation` is forced server-side — any value supplied by the caller is ignored. `config` is validated before processing: `config.montant` must be a finite number > 0 in major currency units and ≤ 1000000 (except type SERVICE, whose amount comes from the service); `config.service` is only accepted with type SERVICE; every `config.dettes[]` entry must belong to your organisation and carry a finite montant > 0. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "paiements:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequest" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/PaymentResponse" } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_CONFIG / INVALID_MONTANT / MONTANT_TOO_LARGE / SERVICE_NOT_ALLOWED / INVALID_DETTES / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_CONFIG / INVALID_MONTANT / MONTANT_TOO_LARGE / SERVICE_NOT_ALLOWED / INVALID_DETTES / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA" } } } } } } ``` ##### HTTP 404 ```json { "description": "ORG_NOT_FOUND / TARGET_NOT_FOUND / DETTE_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ORG_NOT_FOUND / TARGET_NOT_FOUND / DETTE_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /paiements/import Import an already-collected payment `import_paiement` Required scope: `paiements:write`. Records a donation cashed ELSEWHERE (cheque, wire, cash, a legacy software, another platform) as a historical/accounting payment — stored with `imported:true` and `state:"COMPLETED"`. It feeds stats, campaign counters, the CRM and currency conversion, but NO receipt/cerfa is (re)emitted. This is the unitary, validated equivalent of the bulk CLI importers. Use `POST /paiements` (not this) when you want a donor to pay online now. Idempotent when `externalId` is supplied (safe to re-run a migration). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "paiements:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaiementImportInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Paiement" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_AMOUNT / INVALID_METHOD / ASSOC_NOT_FOUND / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_AMOUNT / INVALID_METHOD / ASSOC_NOT_FOUND / INVALID_EXTERNAL_REF / INVALID_EXTERNAL_METADATA" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND / TARGET_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND / TARGET_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-scope": "paiements:write" } ``` ### GET /paiements/{id} Get a payment `get_paiement` Required scope: `paiements:read`. The detail remains available in REFUND_PENDING so an unconfirmed refund can be inspected. Verify an unconfirmed Nedarim refund in Nedarim before retrying. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "paiements:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Paiement" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /paiements/{id}/refund Refund a payment `refund_paiement` Required scope: `paiements:write`. Issues a full refund through the payment's provider. Supported providers are Stripe, external Stripe, iPay, Nedarim and PayGreen. The payment must belong to the API key's organisation, be completed, not grouped and not already refunded. Nedarim preserves the original receipt and issues a negative receipt. An unconfirmed Nedarim or PayGreen response leaves the payment in REFUND_PENDING: verify it with the provider before attempting another refund. PayGreen verifies the order reference, shop, amount, currency and captured funds before submitting a full refund. This financial action is irreversible. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "paiements:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundRequest" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Refund accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundResponse" } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_REASON / INVALID_STATE / GROUPED_PAIEMENT / ALREADY_REFUNDED / REFUND_FAILED / NEDARIM_REFUND_UNCONFIRMED. If pending is true, verify the transaction in Nedarim before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundResponse" } } } } ``` ##### HTTP 404 ```json { "description": "PAIEMENT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "PAIEMENT_NOT_FOUND" } } } } } } ``` ##### HTTP 405 ```json { "description": "METHOD_NOT_ALLOWED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "METHOD_NOT_ALLOWED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "paiements:write", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### GET /forms List forms `list_forms` Required scope: `forms:read`. Lists the org's forms (light fields). Paginated. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" }, "description": "Filter by active state." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FormDefinition" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /forms Create a form `create_form` Required scope: `forms:write`. Creates a form DEFINITION from an editor business object. The transpilation of `additionalFields` and the storage of `products` are handled server-side. Returns the created form in editor shape. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormInput" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /forms/{id} Get a form definition (products, calendars, content) `get_form` Required scope: `forms:read`. Returns the same payload the public website uses to render the form (transpiled `content`), scoped to the API key's organisation. To EDIT a form, read `/forms/{id}/edit` instead. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormDefinition" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /forms/{id} Edit a form `update_form` Required scope: `forms:write`. Partial update of a form DEFINITION (editor business object). Only the fields supplied change; omit `products`/`additionalFields` to leave them untouched, send them to replace the whole set. Returns the updated form in editor shape. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormUpdateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormInput" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /forms/{id}/edit Get a form in EDITOR shape `get_form_edit` Required scope: `forms:read`. Returns the editor business object (products inlined, `additionalFields` rebuilt) — the exact shape `POST /forms` and `PATCH /forms/{id}` accept. Read this before editing. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormInput" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /forms-submit List form submissions `list_forms_submit` Required scope: `forms_submit:read` #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms_submit:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "createdAfter", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter: created after this date (ISO 8601)" } ``` ```json { "name": "createdBefore", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter: created before this date (ISO 8601)" } ``` ```json { "name": "formId", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "SUBMIT", "VALIDE", "INVALIDE" ] }, "description": "Filter by decision state. SUBMIT = awaiting a decision." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FormSubmit" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /forms-submit Submit a form `create_forms_submit` Required scope: `forms_submit:write`. Creates a `forms_submit` document, applies all the same side-effects as the public website (contact CRM sync, totals, promo codes, notifications, payment link). When a payment is needed, the response `url` points to the hosted payment page. Edit mode (`data.extra.editId`) is not supported through this endpoint. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms_submit:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitRequest" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SubmitResponse" } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FORM_ID or EDIT_MODE_NOT_SUPPORTED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FORM_ID or EDIT_MODE_NOT_SUPPORTED" } } } } } } ``` ##### HTTP 404 ```json { "description": "FORM_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "FORM_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /forms-submit/with-payment Submit a form and create the payment link in one call `create_forms_submit_with_payment` Required scopes: `forms_submit:write` AND `paiements:write`. Same behavior as `POST /forms-submit` — convenience endpoint to make the scope intent explicit when the caller knows a payment is expected. The payment URL is returned in `url`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms_submit:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitRequest" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SubmitResponse" } } } } } } ``` ##### HTTP 400 ```json { "description": "MISSING_FORM_ID or EDIT_MODE_NOT_SUPPORTED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "MISSING_FORM_ID or EDIT_MODE_NOT_SUPPORTED" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPES", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPES" } } } } } } ``` ##### HTTP 404 ```json { "description": "FORM_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "FORM_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /forms-submit/{id} Get a form submission `get_forms_submit` Required scope: `forms_submit:read` #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms_submit:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FormSubmit" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /forms-submit/{id}/validate Accept a submission (⚠️ emails the registrant) `validate_submission` Required scope: `forms_submit:validate`. Sets the submission to VALIDE and SENDS a confirmation email to the registrant — a real-world side effect, hence its own scope. Idempotent: returns `already:true` if it was already VALIDE. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms_submit:validate", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:validate", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### POST /forms-submit/{id}/invalidate Refuse a submission (no email) `invalidate_submission` Required scope: `forms_submit:validate`. Sets the submission to INVALIDE. Does NOT email anyone. Idempotent: returns `already:true` if it was already INVALIDE. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "forms_submit:validate", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "forms_submit:validate", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /abonnements List subscriptions `list_abonnements` Required scope: `abonnements:read` #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "abonnements:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" } } ``` ```json { "name": "contactId", "in": "query", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Abonnement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "abonnements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /abonnements/{id} Get a subscription `get_abonnement` Required scope: `abonnements:read` #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "abonnements:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Abonnement" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "abonnements:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /events List standalone events `list_events` Required scope: `events:read`. Lists the org's STANDALONE event sessions (« parcours d'événement »), each with its public form/donation links. Multi-session groups and system groups (e.g. Shabbat) are excluded. Ordered by start date, most recent first. Paginated. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /events/{id} Get a standalone event `get_event` Required scope: `events:read`. Returns one standalone event by id (with its public links). 404 if it is not a standalone event of the org. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Event" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /promesses List donation pledges `list_promesses` Required scope: `promesses:read`. Lists the org's pledges, each enriched with computed `payed`/`reste`/`status` + the donor name. Excludes canceled pledges unless `includeCanceled=true`. Paginated, newest first. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "promesses:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "contactId", "in": "query", "schema": { "type": "string" }, "description": "Filter by donor contact id." } ``` ```json { "name": "typeId", "in": "query", "schema": { "type": "string" }, "description": "Filter by attached livret/campagne id." } ``` ```json { "name": "occasion", "in": "query", "schema": { "type": "string" }, "description": "Filter by occasion (exact match)." } ``` ```json { "name": "includeCanceled", "in": "query", "schema": { "type": "boolean" }, "description": "Include canceled pledges (default false)." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promesse" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /promesses Create a donation pledge `create_promesse` Required scope: `promesses:write`. Creates a pledge for a contact of the org. `montant` is in MAJOR currency units (e.g. 50 = 50€), NOT cents. The currency is always derived from `assoc` (MAIN by default) and cannot be overridden. `organisation` is forced server-side. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "promesses:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromesseCreate" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_MONTANT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_MONTANT" } } } } } } ``` ##### HTTP 404 ```json { "description": "CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /promesses/{id} Get a donation pledge `get_promesse` Required scope: `promesses:read`. Returns the pledge with freshly computed `payed`/`reste`/`status`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "promesses:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /promesses/{id} Update a donation pledge `update_promesse` Required scope: `promesses:write`. Updates any subset of the pledge's editable fields. `assoc`/`devise` are NOT modifiable (fixed at creation). Computed fields (reste/payed/status) are never accepted. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "promesses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromesseUpdate" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" } } } } } } ``` ##### HTTP 400 ```json { "description": "INVALID_MONTANT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_MONTANT" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND or CONTACT_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND or CONTACT_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /promesses/{id} Cancel a donation pledge `delete_promesse` Required scope: `promesses:write`. Soft-deletes the pledge (active=false, state=CANCELED) — it disappears from active lists but is never physically removed. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "promesses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /promesses/{id}/payment-link Create or retrieve the payment link of a pledge `create_promesse_payment_link` Required scope: `promesses:write`. Creates or reuses a hosted payment-page URL so the donor can fulfil the pledge. Refuses (409) if the pledge is canceled, already fully paid, or covered by an active subscription. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "promesses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/PromessePaymentLink" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "PLEDGE_FULFILLED, PLEDGE_CANCELED or PLEDGE_COVERED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "PLEDGE_FULFILLED, PLEDGE_CANCELED or PLEDGE_COVERED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "promesses:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /associations List the org's associations `list_associations` Lists the organisation's legal associations (id, label, currency) so you can pick the right `assoc` when creating a promesse or a paiement. No scope required. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": null, "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /caisses List caisses `list_caisses` Required scope: `caisses:read`. Lists the org's fundraising pots, each enriched with `payed`/`reste`. Paginated. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" }, "description": "Filter by active state." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Caisse" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses Create a caisse `create_caisse` Required scope: `caisses:write`. Creates a fundraising pot. `bgimage` may be an http(s) URL (re-hosted) or a hosted filename. Use `typeId:"AUTO"` for a standalone pot. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaisseInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Caisse" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /caisses/{id} Get a caisse `get_caisse` Required scope: `caisses:read`. Returns the caisse enriched with collected `payed`/`reste`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Caisse" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /caisses/{id} Edit a caisse `update_caisse` Required scope: `caisses:write`. Partial update — only the supplied fields change. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaisseUpdateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Caisse" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/pause Pause a caisse `pause_caisse` Required scope: `caisses:write`. Stops accepting contributions without archiving. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/resume Resume a paused caisse `resume_caisse` Required scope: `caisses:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/archive Archive a caisse `archive_caisse` Required scope: `caisses:write`. Archives and deactivates the pot. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/unarchive Unarchive a caisse `unarchive_caisse` Required scope: `caisses:write`. Restores an archived pot (re-activates it). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /caisses/{id}/delete Deactivate a caisse `delete_caisse` Required scope: `caisses:write`. Soft-deletes (sets active=false). The document is kept. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "caisses:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "caisses:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /pages List pages `list_pages` Required scope: `pages:read`. Lists the org's pages (light fields + joined `url`). Paginated. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "active", "in": "query", "schema": { "type": "boolean" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Page" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages Create a page `create_page` Required scope: `pages:write`. Creates an AI page (content can then be set via PUT /pages/{id}/content). `url` is normalised to slug segments and must be unique. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Page" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR or URL_ALREADY_USED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or URL_ALREADY_USED" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /pages/{id} Get a page `get_page` Required scope: `pages:read`. Full page incl. page SEO (metaTitle/metaDescription/metaImage and language overlays), `html`/`i18n` and the `aiEditable` flag. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Page" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /pages/{id} Edit page metadata `update_page` Required scope: `pages:write`. Partial update of metadata (label/title/description/url/active) and page SEO (metaTitle/metaDescription/metaImage, with alternate-language overlays). Works on AI and legacy pages without modifying their content or editor. Omitted fields and translations are preserved. Null/empty SEO fields restore site defaults, then automatic values. HTTP(S) SEO images are re-hosted, including translations; import failure rejects the write. The home page's URL is locked. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageUpdateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Page" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR or URL_ALREADY_USED or MAIN_PAGE_URL_LOCKED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or URL_ALREADY_USED or MAIN_PAGE_URL_LOCKED" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PUT /pages/{id}/content Set the AI content (HTML) of a page `set_page_content` Required scope: `pages:write`. Sets the page HTML; the server injects data-i18n keys and merges translations (see PageContentInput). Refused with PAGE_CONTENT_NOT_EDITABLE on legacy visual-editor pages. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageContentInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR or PAGE_CONTENT_NOT_EDITABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or PAGE_CONTENT_NOT_EDITABLE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages/{id}/translations Set page translations `set_page_translations` Required scope: `pages:write`. Updates translations of existing data-i18n keys for one language. Does not change the HTML. Refused on legacy pages. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTranslationsInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR or PAGE_CONTENT_NOT_EDITABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR or PAGE_CONTENT_NOT_EDITABLE" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages/{id}/activate Publish a page `activate_page` Required scope: `pages:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /pages/{id}/deactivate Unpublish a page `deactivate_page` Required scope: `pages:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "pages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "pages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /content-blocks List content blocks `list_content_blocks` Required scope: `content_blocks:read`. Lists the org's content blocks (light fields). Paginated. To discover WHICH block backs a given spot, read its referencing config — e.g. the travel `homepage.aiContentBlockId`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "content_blocks:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContentBlock" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /content-blocks/{id} Get a content block `get_content_block` Required scope: `content_blocks:read`. Full block incl. `html`, `i18n` and `mainLang`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "content_blocks:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Content block id — any stable string you choose (a UUID is recommended; generate one with GET /utils/uuid). PUT /content-blocks/{id}/content upserts, so this id need not pre-exist." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ContentBlock" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PUT /content-blocks/{id}/content Set the HTML content of a block `set_content_block_content` Required scope: `content_blocks:write`. Sets the block HTML; the server injects data-i18n keys and merges translations (see ContentBlockContentInput for the mandatory HTML authoring rules). Upserts: if the id does not exist yet the block is created, so you can write a block then link it from a travel homepage (`PATCH /travel/{travelId}/config/homepage` with `aiContentBlockId`) or an event group. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "content_blocks:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Content block id — any stable string you choose (a UUID is recommended; generate one with GET /utils/uuid). PUT /content-blocks/{id}/content upserts, so this id need not pre-exist." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentBlockContentInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /content-blocks/{id}/translations Set content block translations `set_content_block_translations` Required scope: `content_blocks:write`. Updates translations of existing data-i18n keys for one language. Does not change the HTML. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "content_blocks:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Content block id — any stable string you choose (a UUID is recommended; generate one with GET /utils/uuid). PUT /content-blocks/{id}/content upserts, so this id need not pre-exist." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentBlockTranslationsInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "content_blocks:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /email-templates List email templates `list_email_templates` Required scope: `email_templates:read`. Lists the org's email templates (light fields, no html). Paginated. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplate" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates Create an email template `create_email_template` Required scope: `email_templates:write`. Creates a template. `html` is optional (create empty then fill via PUT /{id}/content). Once created, link its id to a campaign as the donor thank-you email (`campagnes.config.donorEmailTemplate`). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCreateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplate" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/{id} Get an email template `get_email_template` Required scope: `email_templates:read`. Full template incl. `html`, `design` and `assets`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplate" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /email-templates/{id} Rename an email template `update_email_template` Required scope: `email_templates:write`. Renames the template (metadata only; use PUT /{id}/content to change the HTML). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateRenameInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /email-templates/{id} Delete an email template `delete_email_template` Required scope: `email_templates:write`. Soft-deletes the template. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### PUT /email-templates/{id}/content Set the HTML content of a template `update_email_template_content` Required scope: `email_templates:write`. Sets the template HTML (regenerates the preview, best-effort). Follow the email-client compatibility rules in EmailTemplateContentInput. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateContentInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplate" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /galleries List photo galleries `list_galleries` Required scope: `galleries:read`. Lists the org's active galleries (no `images[]`; each carries `nbImages` + a cover image). Paginated. Filter with `?category` (a category tag) or `?search` (full-text) or `?contact` (a CRM contact id). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "Filter to galleries carrying this category tag." } ``` ```json { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Full-text search over the galleries." } ``` ```json { "name": "contact", "in": "query", "schema": { "type": "string" }, "description": "Filter to galleries linked to this CRM contact id." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Gallery" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /galleries Create a photo gallery `create_gallery` Required scope: `galleries:write`. Creates an empty album. Add pictures afterwards via POST /galleries/{id}/images. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryCreateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Gallery" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /galleries/categories List gallery categories `list_gallery_categories` Required scope: `galleries:read`. Returns the distinct category tags used across the org's galleries (useful to fill the `category` filter or to reuse an existing tag on create/update). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /galleries/{id} Get a photo gallery `get_gallery` Required scope: `galleries:read`. Returns the album metadata + `nbImages` and the cover image (NOT the full image list — use GET /galleries/{id}/images). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Gallery" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /galleries/{id} Update a photo gallery `update_gallery` Required scope: `galleries:write`. Partial update of the album metadata (name/description/categories/compte/contact). Images are managed via the dedicated endpoints. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryUpdateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Gallery" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /galleries/{id} Delete a photo gallery `delete_gallery` Required scope: `galleries:write`. Soft-deletes the album (hidden from the site and from lists; the document is kept). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /galleries/{id}/images List a gallery's images `list_gallery_images` Required scope: `galleries:read`. Returns a page of the album's image filenames ("md5.ext") plus their public URLs in `meta.imageUrls`. Page-based pagination: `?page` (1-indexed) and `?limit` (default 30). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 30 } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /galleries/{id}/images Add images to a gallery `add_gallery_images` Required scope: `galleries:write`. Adds images to the album. Send EITHER multipart/form-data image file field(s) (max 5mo each, image/* only) OR a JSON body {images:[url|filename]} (http(s) URLs are re-hosted server-side; already-hosted "md5.ext" filenames are attached as-is). Duplicates are ignored. An MCP/AI agent should use the JSON form with URLs. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryAddImagesInput" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "One or more image files (repeat the field for several)." } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "added": { "type": "array", "items": { "type": "string" } }, "addedUrls": { "type": "array", "items": { "type": "string", "format": "uri" } }, "nbImages": { "type": "integer" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### DELETE /galleries/{id}/images Remove images from a gallery `remove_gallery_images` Required scope: `galleries:write`. Detaches images from the album by their hosted filename. The physical files are not deleted. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryRemoveImagesInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "removed": { "type": "array", "items": { "type": "string" } }, "nbImages": { "type": "integer" } } } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /galleries/{id}/images/reorder Reorder a gallery's images `reorder_gallery_images` Required scope: `galleries:write`. Sets the display order of the album's images. `order` must be a permutation of the current filenames; omitted images are appended in their current order (nothing is lost). The first image becomes the cover. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "galleries:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryReorderImagesInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" } } } } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "galleries:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /campaigns List campaigns `list_campaigns` Required scope: `messages:read`. Lists the org's campaigns with delivery stats. Paginated. Filter with `?state` (INIT|VALIDATE|FINISHED) or `?type`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "INIT", "VALIDATE", "FINISHED" ] } } ``` ```json { "name": "type", "in": "query", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /campaigns Create a campaign (draft) `create_campaign` Required scope: `messages:write`. Creates a campaign in state INIT (draft). Does NOT send — use POST /{id}/send. Targeting is mutually exclusive (allContact | staredOnly | categories). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /campaigns/sms/available Remaining SMS quota `get_sms_quota` Required scope: `messages:read`. Returns the org's remaining SMS credits (useful before sending an SMS campaign). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "total": { "type": "integer" } } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /campaigns/{id} Get a campaign `get_campaign` Required scope: `messages:read`. Full campaign incl. delivery stats. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /campaigns/{id} Update a draft campaign `update_campaign` Required scope: `messages:write`. Updates a campaign — only while it is INIT (draft). Returns 409 if it has already been sent. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CAMPAIGN_NOT_EDITABLE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CAMPAIGN_NOT_EDITABLE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /campaigns/{id} Delete a campaign `delete_campaign` Required scope: `messages:write`. Soft-deletes the campaign. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /campaigns/{id}/duplicate Duplicate a campaign `duplicate_campaign` Required scope: `messages:write`. Duplicates the campaign as a fresh INIT draft (new id, scheduledAt cleared, stats reset; media shared by reference). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Campaign" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /campaigns/{id}/targets Preview the recipient count `preview_campaign_targets` Required scope: `messages:read`. Counts the recipients the campaign's stored targeting resolves to, WITHOUT creating any delivery. Returns 0 if no targeting is set. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/CampaignTargets" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /campaigns/{id}/send Send the campaign (real mass send) `send_campaign` Required scope: `messages:send`. **Triggers the real mass send.** Transitions the draft INIT→VALIDATE and enqueues one delivery per resolved recipient; daemons then send via WhatsApp/SMS/email. **Irreversible** and may incur SMS costs, risk WhatsApp number bans (rate limits), and has GDPR implications (messaging real contacts). Preview the audience first with POST /{id}/targets. Idempotent: a campaign already sent (state ≠ INIT) returns 409. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:send", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "state": { "type": "string" }, "targets": { "type": "integer" } } } } } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CAMPAIGN_ALREADY_SENT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CAMPAIGN_ALREADY_SENT" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:send", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### POST /campaigns/{id}/test Send a test to one contact (draft only) `test_campaign` Required scope: `messages:send`. Sends a single test message of the campaign to one contact (real send to that contact; excluded from stats; ignores the unsubscribe list). Allowed ONLY while the campaign is a draft (state INIT) — returns 409 otherwise. Body: {contactId}. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:send", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignTestInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CAMPAIGN_NOT_DRAFT", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CAMPAIGN_NOT_DRAFT" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:send", "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": true, "idempotent": false, "warn": true } } ``` ### POST /uploads Upload a media file (any type) `create_upload` Required scope: `uploads:write` (a `messages:write` key is ALSO accepted here for the campaign flow). Uploads an image/PDF/video (multipart/form-data) and returns its hosted filename + URL, to THEN reference it where it belongs (a contact document, a campaign media…). NOTE: multipart only — for an MCP/AI agent that cannot stream a binary, pass an http(s) `url` to the consuming endpoint instead (e.g. POST /contacts/{id}/documents), which re-hosts it server-side. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "uploads:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/UploadResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "UNSUPPORTED_MEDIA_TYPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNSUPPORTED_MEDIA_TYPE" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "uploads:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /uploads/image Upload an image `create_upload_image` Required scope: `uploads:write`. Uploads an image only (image/*, ≤ 5mo, multipart/form-data) and returns its hosted filename + URL. Mirrors the admin image upload. Multipart only (see POST /uploads note for MCP/AI). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "uploads:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/UploadResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "WRONG_MEDIA_FAMILY", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "WRONG_MEDIA_FAMILY" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "uploads:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /uploads/pdf Upload a PDF `create_upload_pdf` Required scope: `uploads:write`. Uploads a PDF only (application/pdf, ≤ 15mo, multipart/form-data) and returns its hosted filename + URL. Mirrors the admin document upload. Multipart only (see POST /uploads note for MCP/AI). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "uploads:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/UploadResult" } } } } } } ``` ##### HTTP 400 ```json { "description": "WRONG_MEDIA_FAMILY", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "WRONG_MEDIA_FAMILY" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "uploads:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /whatsapp-accounts List connected WhatsApp numbers `list_whatsapp_accounts` Required scope: `messages:read`. Lists the org's connected WhatsApp numbers. Pick a `ready` one's id to set as a campaign's whatsappAccountId. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsappAccount" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /whatsapp-accounts/{id}/status WhatsApp number status `get_whatsapp_account_status` Required scope: `messages:read`. Current status of a number (`ready` = connected & usable). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/WhatsappAccountStatus" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /messaging-configs List email & SMS sending configs `list_messaging_configs` Required scope: `messages:read`. The org's email & SMS sending configs (no secrets). Use an email config id as a campaign's `emailConfig`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "messages:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MessagingConfigs" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "messages:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /menu List menu items (a site's tree) `list_menu` Required scope: `web_menu:read`. Returns the site's items (flat, ordered by position; rebuild the tree via parent/position). Pass `?virtualId` to target a site (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "web_menu:read", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Site id; omit for the main site." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MenuItem" } } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /menu Create a menu item `create_menu_item` Required scope: `web_menu:write`. Creates an item at the end of the root level. Use `targetId` for PAGE/FORM/CAGNOTTE items. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "web_menu:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MenuItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /menu/reorder Reorder / re-parent menu items `reorder_menu` Required scope: `web_menu:write`. Sets parent + position of items in one pass (the tree/drag&drop operation). Send the full desired layout. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "web_menu:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuReorderInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /menu/{id} Edit a menu item `update_menu_item` Required scope: `web_menu:write`. Edits content only (not parent/position). Pass the item's `virtualId` in the body. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "web_menu:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MenuItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /menu/{id} Delete a menu item `delete_menu_item` Required scope: `web_menu:write`. Pass `?virtualId` to scope to the site. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "web_menu:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "web_menu:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /travel List travel sites `list_travel` Required scope: `travel:read`. Lists the organisation's travel sites so you can discover their `travelId`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TravelSite" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 401 ```json { "description": "ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INSUFFICIENT_SCOPE" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId} Get a travel site (config + all places) `get_travel` Required scope: `travel:read`. Returns the sanitized config and every hydrated place collection, plus a `shabbat` bundle (the site's Shabbat group + upcoming sessions, same as GET /travel/{travelId}/shabbat). Chatbot system instructions and provider API keys are never included. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/config Get the site config `list_travel_config` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/shabbat Get the site's Shabbat sessions `get_travel_shabbat` Required scope: `travel:read`. Returns the site's Shabbat group (its public metadata + AI intro block id) and its upcoming/active sessions (same shape as standalone events). Returns `{group:null, sessions:[]}` when the site has no Shabbat configured. Zmanim (entry/exit times) are not included in this version. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ShabbatBundle" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/theme Update config section: theme `update_travel_config_theme` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigTheme" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigTheme" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/jewish-info Update config section: jewishInfo `update_travel_config_jewish_info` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigJewishInfo" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigJewishInfo" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/horaires Update config section: horaires `update_travel_config_horaire` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigHoraires" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigHoraires" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/menu Update config section: menu `update_travel_config_menu` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigMenu" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigMenu" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/hero Update config section: heroBanner `update_travel_config_hero` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigHeroBanner" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigHeroBanner" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/homepage Update config section: homepage `update_travel_config_homepage` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigHomepage" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigHomepage" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/beth-habad Update config section: bethHabad `update_travel_config_beth_habad` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigBethHabad" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigBethHabad" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/services Update config section: services `update_travel_config_service` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigServices" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigServices" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/faq Update config section: faq `update_travel_config_faq` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigFaq" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigFaq" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/journey Update config section: journey `update_travel_config_journey` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigJourney" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigJourney" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/chatbot Update config section: chatbot `update_travel_config_chatbot` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigChatbot" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigChatbot" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/booking-api Update config section: bookingApi `update_travel_config_booking_api` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigBookingApi" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigBookingApi" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/airbnb-api Update config section: airbnbApi `update_travel_config_airbnb_api` Required scope: `travel:write`. Replaces this section only (sibling sections untouched). Uses the native i18n shape (org default language at the root, other languages as overlays). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelConfigAirbnbApi" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelConfigAirbnbApi" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/beth-habad-label Update the "Beth 'Habad" wording (i18n) `update_travel_config_beth_habad_label` Required scope: `travel:write`. Body: `{value, ?…}` (plain strings). `value` is the label in the org's DEFAULT language (`org.language`). Each other key is a translation, keyed by language code — valid keys are the org's enabled languages EXCEPT the default one (sending the default language as a key is rejected). The properties below (en/he/de/gr) are the common cases; fr/it/ru/pt are equally accepted when enabled by the org. Set a translation to **null** to DELETE it (omitting the key leaves it untouched). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "Label in the org's default language (org.language)" }, "en": { "type": "string", "nullable": true, "description": "English translation (if 'en' is an enabled non-default language). null deletes it." }, "he": { "type": "string", "nullable": true, "description": "Hebrew translation (if enabled & not the default). null deletes it." }, "de": { "type": "string", "nullable": true, "description": "German translation (if enabled & not the default). null deletes it." }, "gr": { "type": "string", "nullable": true, "description": "Greek translation (if enabled & not the default). null deletes it." } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/config/categories/{type} Update category list (kosher | hotel | attraction) `update_travel_config_category` Required scope: `travel:write`. Body: `{categories:[{id?, label, en?:{label}}]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "kosher", "hotel", "attraction" ] } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/I18nOverlay" } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "UNKNOWN_CATEGORY_TYPE / TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "UNKNOWN_CATEGORY_TYPE / TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/kosher List kosher `list_travel_kosher` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KosherPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/kosher Create a kosher `create_travel_kosher` Required scope: `travel:write`. `id` is generated; `organisation`/`travel` are forced server-side. Image fields accept an http(s) URL (re-hosted) or a filename. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KosherPlace" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KosherPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/kosher/{id} Get a kosher `get_travel_kosher` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KosherPlace" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/kosher/{id} Update a kosher `update_travel_kosher` Required scope: `travel:write`. Merges the sanitized fields onto the existing document. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KosherPlace" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KosherPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/kosher/{id} Delete a kosher `delete_travel_kosher` Required scope: `travel:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/kosher/positions Reorder kosher `reorder_travel_kosher` Required scope: `travel:write`. Body: `{positions:[{id, position}]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/hotels List hotels `list_travel_hotels` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/HotelPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/hotels Create a hotel `create_travel_hotels` Required scope: `travel:write`. `id` is generated; `organisation`/`travel` are forced server-side. Image fields accept an http(s) URL (re-hosted) or a filename. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HotelPlace" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/HotelPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/hotels/{id} Get a hotel `get_travel_hotel` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/HotelPlace" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/hotels/{id} Update a hotel `update_travel_hotel` Required scope: `travel:write`. Merges the sanitized fields onto the existing document. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HotelPlace" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/HotelPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/hotels/{id} Delete a hotel `delete_travel_hotel` Required scope: `travel:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/hotels/positions Reorder hotels `reorder_travel_hotels` Required scope: `travel:write`. Body: `{positions:[{id, position}]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/attractions List attractions `list_travel_attractions` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AttractionPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/attractions Create a attraction `create_travel_attractions` Required scope: `travel:write`. `id` is generated; `organisation`/`travel` are forced server-side. Image fields accept an http(s) URL (re-hosted) or a filename. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttractionPlace" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AttractionPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/attractions/{id} Get a attraction `get_travel_attraction` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AttractionPlace" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/attractions/{id} Update a attraction `update_travel_attraction` Required scope: `travel:write`. Merges the sanitized fields onto the existing document. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttractionPlace" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AttractionPlace" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/attractions/{id} Delete a attraction `delete_travel_attraction` Required scope: `travel:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/attractions/positions Reorder attractions `reorder_travel_attractions` Required scope: `travel:write`. Body: `{positions:[{id, position}]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/bookings List imported bookings `list_travel_bookings` Required scope: `travel:read`. Read-only (imported via the backoffice). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BookingPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/airbnbs List imported airbnbs `list_travel_airbnbs` Required scope: `travel:read`. Read-only (imported via the backoffice). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AirbnbPlace" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/journeys List trip-announcement requests `list_travel_journeys` Required scope: `travel:read`. Inbound tourist requests linked to a CRM contact. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "seasonId", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "includeCancelled", "in": "query", "schema": { "type": "boolean" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Journey" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/sections List custom sections (rubrics) `list_travel_sections` Required scope: `travel:read`. Each rubric carries an `itemCount`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TravelSection" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections Create a custom section (rubric) `create_travel_sections` Required scope: `travel:write`. `slug` is normalised + made unique per site (derived from `label` when omitted). `fields` toggles which item fields the rubric uses. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSection" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSection" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/sections/{sid} Get a custom section `get_travel_section` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSection" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/sections/{sid} Update a custom section `update_travel_section` Required scope: `travel:write`. Partial update; the slug is re-derived when `label`/`slug` change. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSection" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSection" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/sections/{sid} Delete a custom section (cascades to its items) `delete_travel_section` Required scope: `travel:write`. All places of the rubric are deleted too. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections/positions Reorder custom sections `reorder_travel_sections` Required scope: `travel:write`. Body: `{positions:[{id, position}]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "TRAVEL_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "TRAVEL_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /travel/{travelId}/sections/{sid}/items List places of a custom section `list_travel_sections_items` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TravelSectionItem" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections/{sid}/items Create a place in a custom section `create_travel_sections_items` Required scope: `travel:write`. `sectionId` is forced from the path. Item fields not enabled by the rubric's `fields` toggles are still accepted (the third party renders its own UI). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSectionItem" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSectionItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /travel/{travelId}/sections/{sid}/items/{id} Get a place of a custom section `get_travel_sections_item` Required scope: `travel:read`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:read", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSectionItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /travel/{travelId}/sections/{sid}/items/{id} Update a place of a custom section `update_travel_sections_item` Required scope: `travel:write`. Partial update. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelSectionItem" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/TravelSectionItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /travel/{travelId}/sections/{sid}/items/{id} Delete a place of a custom section `delete_travel_sections_item` Required scope: `travel:write`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### POST /travel/{travelId}/sections/{sid}/items/positions Reorder places of a custom section `reorder_travel_sections_items` Required scope: `travel:write`. Body: `{positions:[{id, position}]}`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "travel:write", "additional": [] } ``` #### פרמטרים ```json { "name": "travelId", "in": "path", "required": true, "schema": { "type": "string" } } ``` ```json { "name": "sid", "in": "path", "required": true, "schema": { "type": "string" } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "positions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } } } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } ``` ##### HTTP 404 ```json { "description": "SECTION_NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "SECTION_NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "travel:write", "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site/facades List the org's façades (sites) `list_site_facades` Required scope: `site:read`. Lists the main site + virtual sites so you know which `virtualId` to pass to the other /site operations. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SiteFacade" } } } } } } } ``` ##### HTTP 401 ```json { "description": "Missing or invalid key" } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site Get the classic site theme config `get_site` Required scope: `site:read`. Returns the normalised theme config (appearance, menu, hero, banners, homeSections, preFooterSections, donationPage) of the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:read", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/appearance Set theme + colour/font tokens `update_site_appearance` Required scope: `site:write`. Sets the active `theme` and/or the 2026 `tokens`; each provided field replaces its target. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteAppearance" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site/seo Get the site's default SEO `get_site_seo` Required scope: `site:read`. Default SEO for the homepage and any public CMS page without its own SEO. Each field resolves independently: explicit page SEO, then this site default, then the existing automatically generated value. Applies to classic, Travel, mobile and campaign themes. Default-language values live at the root; enabled alternate languages use partial overlays. Omitted fields/overlays are preserved; null or an empty string clears an individual value (restores fallback). A null/empty language object removes that overlay only. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:read", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteSeo" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/seo Update the site's default SEO `update_site_seo` Required scope: `site:write`. Default SEO for the homepage and any public CMS page without its own SEO. Each field resolves independently: explicit page SEO, then this site default, then the existing automatically generated value. Applies to classic, Travel, mobile and campaign themes. Default-language values live at the root; enabled alternate languages use partial overlays. Omitted fields/overlays are preserved; null or an empty string clears an individual value (restores fallback). A null/empty language object removes that overlay only. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteSeo" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteSeo" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR" } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /site/donation-page Get all main donation page settings `get_site_donation_page` Required scope: `site:read`. Returns all settings of the main donation page, including alternate-language content/media/preset arrays, the linked main caisse and the main /don redirect. Works with classic, Travel and mobile themes. Also available as donationPage in GET /site. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:read", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteDonationPage" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND" } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/donation-page Update all main donation page settings `update_site_donation_page` Required scope: `site:write`. Main donation page settings (admin « Ma page de don »), shared by the classic, Travel and mobile themes. Partial update: omitted fields and translations are preserved. Media/preset arrays replace the supplied array. Default-language values live at the root; alternate languages can override the five presentation fields, including whole arrays. A linked mainCaisse supplies its own content/media/presets; redirect takes precedence over the main /don page. This does not change organisation-wide payment-provider settings or campaign configuration. Omitted fields within a language overlay are preserved too. Send a language as null or {} to delete only this page's translations for that language, preserving other website translations. Null on an individual translated text/image clears that override; [] empties a translated array. Images are re-hosted in root and alternate languages; an import failure rejects the update. Unknown fields, disabled language overlays and non-translatable routing fields in an overlay are rejected. The mainCaisse must belong to this organisation. Use GET /me to discover defaultLanguage/enabledLanguages. Manage global payment providers separately. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteDonationPage" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SiteDonationPage" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND, CAISSE_NOT_FOUND or NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/menu Set the header CTA buttons `update_site_menu` Required scope: `site:write`. Replaces the two header call-to-action buttons (send the full object). Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteMenu" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/hero Set the hero carousel slides `update_site_hero` Required scope: `site:write`. Replaces the whole hero carousel with the supplied `slides` array. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "slides" ], "properties": { "slides": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSlide" }, "description": "Ordered hero slides (replaces the carousel)." } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/banners Set the promo banners `update_site_banners` Required scope: `site:write`. Replaces the promo banners with the supplied `items` array. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSlide" }, "description": "Promo banners (replaces them all)." } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/home-sections Set the home page sections `update_site_home_sections` Required scope: `site:write`. Replaces the home page composition with the supplied `sections` array (order = on-page order). GET /site first to keep the built-in sections + ids. A CUSTOM_CONTENT section with props.contentType="AI" references an aiContentBlockId — write its HTML via PUT /content-blocks/{id}/content. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSection" }, "description": "Ordered home sections (replaces the composition)." } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /site/prefooter-sections Set the pre-footer sections `update_site_prefooter_sections` Required scope: `site:write`. Replaces the sections shown before the footer on every page. Targets the façade in `?virtualId` (omit = main site). #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "site:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/SiteSection" }, "description": "Ordered pre-footer sections (replaces them all)." } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "site:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /mobile-config/facades List the org's mobile-app façades `list_mobile_config_facades` Required scope: `mobile_config:read`. Lists the main app + virtual apps so you know which `virtualId` to pass to the other /mobile-config operations. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MobileFacade" } } } } } } } ``` ##### HTTP 401 ```json { "description": "Missing or invalid key" } ``` ##### HTTP 403 ```json { "description": "INSUFFICIENT_SCOPE" } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /mobile-config Get the mobile app config `get_mobile_config` Required scope: `mobile_config:read`. Returns the normalised mobile config (label, active, config.*, plus read-only distribution & knownHosts) of the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:read", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MobileConfig" } } } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED" } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/meta Set the app config label / active `update_mobile_config_meta` Required scope: `mobile_config:write`. Sets the root lifecycle meta (`label` and/or `active`). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileMeta" }, "example": { "label": "App Beth Habad", "active": true } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/branding Set the app accent colours `update_mobile_config_branding` Required scope: `mobile_config:write`. Sets the in-app accent colours (primary/secondary). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileBranding" }, "example": { "primary": "#1D4ED8", "secondary": "#F59E0B" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/bottom-bar Set the bottom bar appearance `update_mobile_config_bottom_bar` Required scope: `mobile_config:write`. Sets the bottom tab bar appearance (visible / variant / showLabels). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileBottomBar" }, "example": { "visible": true, "variant": "fixed", "showLabels": true } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/tabs Set the bottom-bar tabs `update_mobile_config_tabs` Required scope: `mobile_config:write`. Replaces the whole bottom-bar tab list with the supplied `tabs` array (order = on-screen order). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "tabs" ], "properties": { "tabs": { "type": "array", "items": { "$ref": "#/components/schemas/MobileTab" }, "description": "Ordered bottom-bar tabs (replaces them all)." } } }, "example": { "tabs": [ { "url": "", "label": "Accueil", "icon": { "name": "home", "source": "lucide" }, "active": true }, { "url": "/don", "label": "Don", "en": { "label": "Donate" }, "icon": { "name": "heart", "source": "lucide" }, "active": true } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/header Set the app header `update_mobile_config_header` Required scope: `mobile_config:write`. Sets the app-shell top bar (visible / sticky / showBack / title / actions). Send the full object. Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileHeader" }, "example": { "visible": true, "sticky": true, "showBack": true, "title": { "mode": "SHORTNAME" }, "actions": [ { "type": "DRAWER", "icon": { "name": "menu", "source": "lucide" }, "label": "Menu" } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/onboarding Set the onboarding carousel `update_mobile_config_onboarding` Required scope: `mobile_config:write`. Sets the first-launch onboarding carousel (enabled / version / slides). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileOnboarding" }, "example": { "enabled": true, "version": 1, "slides": [ { "title": "Bienvenue", "en": { "title": "Welcome" }, "description": "Découvrez notre app", "textPosition": "bottom", "overlay": "LIGHT" } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/account Set the account sign-in gating `update_mobile_config_account` Required scope: `mobile_config:write`. Sets whether the app asks the user to sign in (mode NONE/OPTIONAL/REQUIRED + version). Only honoured when the account space is available for the org. Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileAccount" }, "example": { "mode": "OPTIONAL", "version": 1 } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/initial-url Set the app boot URL `update_mobile_config_initial_url` Required scope: `mobile_config:write`. Sets the exact URL the app opens at boot (`initialUrl`); empty = auto-derive from the org domain. Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileInitialUrl" }, "example": { "initialUrl": "/accueil-app" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/external-apps Set the external-link routing rules `update_mobile_config_external_apps` Required scope: `mobile_config:write`. Replaces the list of links that open natively instead of the in-app browser (supplied as `items`). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MobileExternalApp" }, "description": "External-link routing rules (replaces them all)." } } }, "example": { "items": [ { "match": "my-partner.com", "mode": "SYSTEM" } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/sections Set the home sections `update_mobile_config_sections` Required scope: `mobile_config:write`. Replaces the mobile home composition with the supplied `sections` array (order = on-screen order). GET /mobile-config first to keep existing sections + ids. A CUSTOM_CONTENT section with props.contentType="AI" references an aiContentBlockId — write its HTML via PUT /content-blocks/{id}/content. Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/MobileSection" }, "description": "Ordered home sections (replaces the composition)." } } }, "example": { "sections": [ { "type": "HERO", "label": "Hero", "props": { "slides": [ { "image": "https://example.com/hero.jpg", "title": "Bienvenue", "btn1_label": "Faire un don", "btn1_url": "/don" } ] } }, { "type": "ACTIONS_GRID", "label": "Raccourcis", "props": { "style": "ROUND", "items": [ { "icon": { "name": "heart", "source": "lucide" }, "label": "Don", "url": "/don" } ] } }, { "type": "EVENTS_PREVIEW", "label": "Événements", "props": { "title": "Nos événements", "limit": 5 } } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /mobile-config/prefooter-sections Set the pre-footer sections `update_mobile_config_prefooter_sections` Required scope: `mobile_config:write`. Replaces the sections shown before the footer on every screen (supplied as `sections`). Targets the façade in `?virtualId` (omit = main app). 404 if the app is not provisioned. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "mobile_config:write", "additional": [] } ``` #### פרמטרים ```json { "name": "virtualId", "in": "query", "schema": { "type": "string" }, "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/MobileSection" }, "description": "Ordered pre-footer sections (replaces them all)." } } }, "example": { "sections": [ { "type": "NEWSLETTER", "label": "Newsletter", "props": { "title": "Restez informés" } } ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` ##### HTTP 404 ```json { "description": "FACADE_NOT_FOUND or MOBILE_CONFIG_NOT_PROVISIONED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "mobile_config:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /annual-events List managed annual events `list_annual_events` Required scope: `events:read`. Lists event projects created through the guided annual-event facade. Includes one-off and recurring ordinary events, and excludes all Shabbat / prefab-holiday flows by construction. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` ```json { "name": "year", "in": "query", "schema": { "type": "integer", "minimum": 2000, "maximum": 2200 } } ``` ```json { "name": "publicationStatus", "in": "query", "schema": { "type": "string", "enum": [ "CREATED", "PUBLISHED", "PUBLISHING", "PUBLISH_FAILED" ] } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnualEventProject" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 403 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "INSUFFICIENT_SCOPE" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /annual-events Create and publish an ordinary event `create_annual_event` Required scope: `events:write`. Idempotently coordinates the page, group, sessions and requested form/fundraiser/campaign draft from one reviewed recipe. `idempotencyKey` is required in the JSON body for both REST and MCP; the optional `Idempotency-Key` header may override it for transport-level retries. A campaign is always left in draft and is never sent here. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:write", "additional": [] } ``` #### פרמטרים ```json { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "maxLength": 200 } } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventCreateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventPublishResult" } } } } ``` ##### HTTP 400 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "INVALID_INPUT" } } } } ``` ##### HTTP 409 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "CONFLICT" } } } } ``` ##### HTTP 422 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "VALIDATION_ERROR" } } } } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "action", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "events:write" } ``` ### GET /annual-events/groups List compatible ordinary event groups `list_annual_event_groups` Required scope: `events:read`. Lists only ordinary single-session groups that can safely receive a new event. Shabbat, prefab-holiday and multi-session groups are excluded. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:read", "additional": [] } ``` #### פרמטרים ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Number of results per page" } ``` ```json { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor returned by the previous request" } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnualEventCompatibleGroup" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 403 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "INSUFFICIENT_SCOPE" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /annual-events/poster-analysis Prepare an event draft from a poster `analyze_annual_event_poster` Required scope: `events:write`. Reads a real poster image and returns a comprehensive suggested recipe. This does not publish anything; the caller must show the result for review, complete uncertain fields, then call `create_annual_event`. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventPosterAnalysisRequest" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AnnualEventPosterAnalysis" } } } } } } ``` ##### HTTP 400 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "INVALID_POSTER" } } } } ``` ##### HTTP 404 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "POSTER_NOT_FOUND" } } } } ``` ##### HTTP 503 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "AI_UNAVAILABLE" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /annual-events/{id} Get a managed annual event `get_annual_event` Required scope: `events:read`. Returns the canonical project, its reviewed recipe, revision, public URL and the ids of its sessions, forms, fundraisers and campaign drafts. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{3,128}$" }, "description": "Annual-event project id." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AnnualEventProject" } } } } } } ``` ##### HTTP 404 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "EVENT_NOT_FOUND" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /annual-events/{id} Update and republish a managed annual event `update_annual_event` Required scope: `events:write`. Applies a partial patch to the stored recipe and republishes its managed resources. Send `expectedRevision` to reject a stale edit with 409. Arrays supplied in the patch replace their previous value. A campaign remains a draft and is never sent here. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "events:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{3,128}$" }, "description": "Annual-event project id." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "expectedRevision": { "type": "integer", "minimum": 1 }, "patch": { "$ref": "#/components/schemas/AnnualEventPatch" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "timeZone": { "type": "string" } }, "required": [ "expectedRevision", "patch" ] } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnualEventPublishResult" } } } } ``` ##### HTTP 404 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "EVENT_NOT_FOUND" } } } } ``` ##### HTTP 409 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "REVISION_CONFLICT" } } } } ``` ##### HTTP 422 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } }, "description": "VALIDATION_ERROR" } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "events:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /fundraising-campaigns list Fundraising Campaigns `listFundraisingCampaigns` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` ```json { "in": "query", "name": "search", "schema": { "type": "string", "maxLength": 200 } } ``` ```json { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "DRAFT", "PUBLISHED", "PAUSED", "ARCHIVED" ] } } ``` ```json { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] } } ``` ```json { "in": "query", "name": "dateStartFrom", "schema": { "type": "string", "format": "date-time" } } ``` ```json { "in": "query", "name": "dateStartTo", "schema": { "type": "string", "format": "date-time" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingCampaignRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns create Fundraising Campaign `createFundraisingCampaign` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "maxLength": 60, "pattern": "^campaign-[a-z0-9][a-z0-9-]{0,49}[a-z0-9]$" }, "type": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 1000000000, "multipleOf": 0.01 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "partnerMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "dateStart": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "dateEnd": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "donationPolicy": { "type": "string", "enum": [ "OPEN", "SCHEDULED" ] }, "bonus": { "type": "array", "items": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxItems": 30 }, "gala": { "type": "boolean" }, "ambs": { "type": "boolean" }, "stockable": { "type": "boolean" }, "tombola": { "type": "boolean", "deprecated": true, "description": "Historical alias for stockable. Read for compatibility; use stockable for new campaigns." }, "presentCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "ambsCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "config": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "V2 presentation layout. Missing, empty or unsupported values render the current standard design. Independent of colors and checkout; preserved for forward compatibility." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." } }, "required": [], "additionalProperties": false }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "url", "objectif" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/resolve/{url} resolve Fundraising Campaign `resolveFundraisingCampaign` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "url", "required": true, "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id} get Fundraising Campaign `getFundraisingCampaign` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id} update Fundraising Campaign `updateFundraisingCampaign` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "maxLength": 60, "pattern": "^campaign-[a-z0-9][a-z0-9-]{0,49}[a-z0-9]$" }, "type": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 1000000000, "multipleOf": 0.01 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "partnerMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "dateStart": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "dateEnd": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "donationPolicy": { "type": "string", "enum": [ "OPEN", "SCHEDULED" ] }, "bonus": { "type": "array", "items": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxItems": 30 }, "gala": { "type": "boolean" }, "ambs": { "type": "boolean" }, "stockable": { "type": "boolean" }, "tombola": { "type": "boolean", "deprecated": true, "description": "Historical alias for stockable. Read for compatibility; use stockable for new campaigns." }, "presentCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "ambsCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "config": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "V2 presentation layout. Missing, empty or unsupported values render the current standard design. Independent of colors and checkout; preserved for forward compatibility." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." } }, "required": [], "additionalProperties": false }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/duplicate duplicate Fundraising Campaign `duplicateFundraisingCampaign` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "maxLength": 60, "pattern": "^campaign-[a-z0-9][a-z0-9-]{0,49}[a-z0-9]$" }, "type": { "type": "string", "enum": [ "AMOUNT", "COUNT", "PARTNER" ] }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 1000000000, "multipleOf": 0.01 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "partnerMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "dateStart": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "dateEnd": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "donationPolicy": { "type": "string", "enum": [ "OPEN", "SCHEDULED" ] }, "bonus": { "type": "array", "items": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxItems": 30 }, "gala": { "type": "boolean" }, "ambs": { "type": "boolean" }, "stockable": { "type": "boolean" }, "tombola": { "type": "boolean", "deprecated": true, "description": "Historical alias for stockable. Read for compatibility; use stockable for new campaigns." }, "presentCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "ambsCategories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "config": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "V2 presentation layout. Missing, empty or unsupported values render the current standard design. Independent of colors and checkout; preserved for forward compatibility." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." } }, "required": [], "additionalProperties": false }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 120 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "url" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/publish publish Fundraising Campaign `publishFundraisingCampaign` Required scope: `fundraising:publish`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### POST /fundraising-campaigns/{id}/pause pause Fundraising Campaign `pauseFundraisingCampaign` Required scope: `fundraising:publish`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### POST /fundraising-campaigns/{id}/resume resume Fundraising Campaign `resumeFundraisingCampaign` Required scope: `fundraising:publish`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### POST /fundraising-campaigns/{id}/archive archive Fundraising Campaign `archiveFundraisingCampaign` Required scope: `fundraising:publish`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:publish", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:publish" } ``` ### GET /fundraising-campaigns/{id}/config get Fundraising Configuration `getFundraisingConfiguration` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingConfig" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/config/{section} update Fundraising Configuration `updateFundraisingConfiguration` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "section", "required": true, "schema": { "type": "string", "enum": [ "content", "appearance", "donations", "currencies", "automation" ] } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 }, "label": { "type": "string", "maxLength": 300 }, "hidden": { "type": "boolean" }, "editable": { "type": "boolean" }, "contentType": { "type": "string", "enum": [ "EDITOR", "AI" ] }, "aiContentBlockId": { "type": "string", "maxLength": 36, "format": "uuid" }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "background": { "type": "string", "maxLength": 100 }, "color": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" } }, "required": [ "id", "type" ], "additionalProperties": false }, "maxItems": 50 }, "banners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 36, "format": "uuid" }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "type": { "type": "string", "enum": [ "DESKTOP", "MOBILE" ] } }, "required": [ "image", "type" ], "additionalProperties": false }, "maxItems": 30 }, "metaImage": { "type": "string", "maxLength": 255, "format": "asset" }, "banners.youtube": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "template": { "type": "string", "maxLength": 300 }, "designVariant": { "type": "string", "maxLength": 300, "description": "V2 presentation layout. Missing, empty or unsupported values render the current standard design. Independent of colors and checkout; preserved for forward compatibility." }, "ambiance": { "type": "string", "maxLength": 300 }, "ald.logo": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.name": { "type": "string", "maxLength": 300 }, "ald.leftBanner": { "type": "string", "maxLength": 255, "format": "asset" }, "ald.presetButtons": { "type": "string", "maxLength": 2000 }, "tokens": { "type": "object", "properties": { "main": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 }, "custom": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500 }, "maxProperties": 100 } }, "required": [], "additionalProperties": false }, "v2Checkout": { "type": "boolean" }, "noModal": { "type": "boolean" }, "noPromesse": { "type": "boolean" }, "hideBar": { "type": "boolean" }, "hideOrg": { "type": "boolean" }, "autoDisplay": { "type": "boolean" }, "forceCelebration": { "type": "boolean" }, "fixedMontant": { "type": "boolean" }, "noDefaultProduct": { "type": "boolean" }, "giftAidBoost": { "type": "boolean" }, "minMontant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "productMonth": { "type": "boolean" }, "maxNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "minNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "defaultNbMonth": { "type": "integer", "minimum": 1, "maximum": 120 }, "forceMonthNb": { "type": "integer", "minimum": 0, "maximum": 120, "nullable": true }, "maxDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "monthlyAmountDisplay": { "type": "boolean" }, "forceDivideGTEAmount": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "forceDivideNB": { "type": "integer", "minimum": 1, "maximum": 120 }, "matched": { "type": "number", "minimum": 1, "maximum": 100 }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "type": { "type": "string", "enum": [ "REAL", "VIRTUAL" ] }, "label": { "type": "string", "maxLength": 300 }, "assocId": { "type": "string", "maxLength": 100 } }, "required": [ "devise", "type" ], "additionalProperties": false }, "maxItems": 20 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 60 }, "maxItems": 20 }, "donorEmailTemplate": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "donorEmailSubject": { "type": "string", "maxLength": 200 }, "fr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "donationButtonText": { "type": "string", "maxLength": 300 }, "donorName": { "type": "string", "maxLength": 300 }, "donorNameMulti": { "type": "string", "maxLength": 300 }, "sections": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 300 }, "content": { "type": "string", "maxLength": 50000 }, "html": { "type": "string", "maxLength": 50000 }, "title": { "type": "string", "maxLength": 300 }, "description": { "type": "string", "maxLength": 50000 }, "id": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false }, "maxItems": 50 }, "donorEmailSubject": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false, "description": "Partial fields of the selected section: content, appearance, donations, currencies or automation. Only that section's fields are persisted." } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCampaignRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/sections/{childId}/content get Fundraising Section Content `getFundraisingSectionContent` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingSectionContentRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/sections/{childId}/content update Fundraising Section Content `updateFundraisingSectionContent` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "maxLength": 500000 }, "editVersion": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "content", "editVersion" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingSectionContentRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/public get Fundraising Public `getFundraisingPublic` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "allOf": [ { "$ref": "#/components/schemas/FundraisingCampaignRead" }, { "type": "object", "properties": { "progress": { "$ref": "#/components/schemas/FundraisingProgress" }, "teams": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingteamsRead" } }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingsourcesRead" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingproductsRead" } }, "counters": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingcountersRead" } } } } ] }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/progress get Fundraising Progress `getFundraisingProgress` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingProgress" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/donors get Fundraising Donors `getFundraisingDonors` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingDonor" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/stats get Fundraising Stats `getFundraisingStats` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingProgress" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/teams list Fundraising Teams `listFundraisingTeams` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingteamsRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/teams create Fundraising Team `createFundraisingTeam` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "description": { "type": "string", "maxLength": 50000 }, "color": { "type": "string", "maxLength": 9, "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$" }, "hidden": { "type": "boolean" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "param" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingteamsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/teams/{childId} get Fundraising Team `getFundraisingTeam` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingteamsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/teams/{childId} update Fundraising Team `updateFundraisingTeam` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "objectif": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "description": { "type": "string", "maxLength": 50000 }, "color": { "type": "string", "maxLength": 9, "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$" }, "hidden": { "type": "boolean" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingteamsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/teams/{childId} delete Fundraising Team `deleteFundraisingTeam` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/sources list Fundraising Sources `listFundraisingSources` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingsourcesRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/sources create Fundraising Source `createFundraisingSource` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label", "param" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingsourcesRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/sources/{childId} get Fundraising Source `getFundraisingSource` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingsourcesRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/sources/{childId} update Fundraising Source `updateFundraisingSource` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "param": { "type": "string", "maxLength": 100, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingsourcesRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/sources/{childId} delete Fundraising Source `deleteFundraisingSource` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/products list Fundraising Products `listFundraisingProducts` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingproductsRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/products create Fundraising Product `createFundraisingProduct` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "prices": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxProperties": 20 }, "stock": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "name", "montant" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingproductsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/products/{childId} get Fundraising Product `getFundraisingProduct` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingproductsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/products/{childId} update Fundraising Product `updateFundraisingProduct` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "image": { "type": "string", "maxLength": 255, "format": "asset" }, "prices": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "maxProperties": 20 }, "stock": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingproductsRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/products/{childId} delete Fundraising Product `deleteFundraisingProduct` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/products/positions order Fundraising Products `orderFundraisingProducts` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "maxLength": 36, "format": "uuid" }, "maxItems": 200 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "ids" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/counters list Fundraising Counters `listFundraisingCounters` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FundraisingcountersRead" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/counters create Fundraising Counter `createFundraisingCounter` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "nb": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "label" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingcountersRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/counters/{childId} get Fundraising Counter `getFundraisingCounter` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingcountersRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/counters/{childId} update Fundraising Counter `updateFundraisingCounter` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 }, "nb": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "position": { "type": "integer", "minimum": 0, "maximum": 10000 }, "fr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "en": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "he": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "de": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "it": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "es": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "pt": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ru": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "gr": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "ro": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 50000 } }, "required": [], "additionalProperties": false, "nullable": true, "description": "Enabled secondary-language overlay. Default language uses root fields; null removes an overlay." }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingcountersRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/counters/{childId} delete Fundraising Counter `deleteFundraisingCounter` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/counters/positions order Fundraising Counters `orderFundraisingCounters` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "maxLength": 36, "format": "uuid" }, "maxItems": 200 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "ids" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "reorder", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/ambassadors list Fundraising Ambassadors `listFundraisingAmbassadors` Required scope: `fundraising:read`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/ambassadors assign Fundraising Ambassador `assignFundraisingAmbassador` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "teamId": { "type": "string", "maxLength": 36, "format": "uuid" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "contactId", "teamId" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/ambassadors/{childId} remove Fundraising Ambassador `removeFundraisingAmbassador` Required scope: `fundraising:write`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/checkouts create Fundraising Checkout `createFundraisingCheckout` Required scope: `fundraising:checkout`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. Creates an expiring hosted Unisoft checkout URL, without charging. RECURRING requires amountBasis MONTHLY; INSTALLMENTS requires amountBasis TOTAL and a total divisible by installments. VIRTUAL currencies are display-only: submit the principal currency. Provider confirmation determines COMPLETED; returnUrl does not. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 100000000 }, "devise": { "type": "string", "maxLength": 3, "pattern": "^[a-z]{3}$" }, "mode": { "type": "string", "enum": [ "ONCE", "RECURRING", "INSTALLMENTS" ] }, "installments": { "type": "integer", "minimum": 1, "maximum": 120 }, "amountBasis": { "type": "string", "enum": [ "MONTHLY", "TOTAL" ] }, "returnUrl": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "reservationId": { "type": "string", "maxLength": 36, "format": "uuid" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "amount", "devise" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCheckoutRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### GET /fundraising-campaigns/{id}/checkouts/{childId} get Fundraising Checkout `getFundraisingCheckout` Required scope: `fundraising:checkout`. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCheckoutRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-scope": "fundraising:checkout" } ``` ### POST /fundraising-campaigns/{id}/checkouts/{childId}/cancel cancel Fundraising Checkout `cancelFundraisingCheckout` Required scope: `fundraising:checkout`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/FundraisingCheckoutRead" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### POST /fundraising-campaigns/{id}/reservations reserve Fundraising Products `reserveFundraisingProducts` Required scope: `fundraising:checkout`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 64, "pattern": "^[A-Za-z0-9_-]{1,64}$" }, "nb": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "required": [ "id", "nb" ], "additionalProperties": false }, "maxItems": 50 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "products" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### DELETE /fundraising-campaigns/{id}/reservations/{childId} release Fundraising Products `releaseFundraisingProducts` Required scope: `fundraising:checkout`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### GET /fundraising-campaigns/{id}/payments list Fundraising Payments `listFundraisingPayments` Required scope: `fundraising:read`. Also requires `paiements:read` (both permissions are checked). Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [ "paiements:read" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Paiement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### GET /fundraising-campaigns/{id}/subscriptions list Fundraising Subscriptions `listFundraisingSubscriptions` Required scope: `fundraising:read`. Also requires `abonnements:read` (both permissions are checked). Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [ "abonnements:read" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Abonnement" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "abonnements:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/subscriptions/{childId}/cancel cancel Fundraising Subscription `cancelFundraisingSubscription` Required scope: `fundraising:write`. Also requires `abonnements:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "abonnements:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": true, "idempotent": true, "warn": true }, "x-unisoft-additional-scopes": [ "abonnements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/pledges list Fundraising Pledges `listFundraisingPledges` Required scope: `fundraising:read`. Also requires `promesses:read` (both permissions are checked). Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [ "promesses:read" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ``` ```json { "in": "query", "name": "cursor", "schema": { "type": "string" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Promesse" } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### POST /fundraising-campaigns/{id}/pledges create Fundraising Pledge `createFundraisingPledge` Required scope: `fundraising:write`. Also requires `promesses:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "name": { "type": "string", "maxLength": 300 }, "occasion": { "type": "string", "maxLength": 300 }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "contactId", "montant" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### GET /fundraising-campaigns/{id}/pledges/{childId} get Fundraising Pledge `getFundraisingPledge` Required scope: `fundraising:read`. Also requires `promesses:read` (both permissions are checked). Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:read", "additional": [ "promesses:read" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:read" ], "x-unisoft-scope": "fundraising:read" } ``` ### PATCH /fundraising-campaigns/{id}/pledges/{childId} update Fundraising Pledge `updateFundraisingPledge` Required scope: `fundraising:write`. Also requires `promesses:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "name": { "type": "string", "maxLength": 300 }, "occasion": { "type": "string", "maxLength": 300 }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Promesse" }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/pledges/{childId}/cancel cancel Fundraising Pledge `cancelFundraisingPledge` Required scope: `fundraising:write`. Also requires `promesses:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/pledges/{childId}/payment-link create Fundraising Pledge Payment Link `createFundraisingPledgePaymentLink` Required scope: `fundraising:write`. Also requires `promesses:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "promesses:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "promesses:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/offline-donations record Fundraising Offline Donation `recordFundraisingOfflineDonation` Required scope: `fundraising:write`. Also requires `paiements:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. Records money already collected; imported:true, no duplicate receipt or provider charge. REST only. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 100000000 }, "method": { "type": "string", "enum": [ "CB", "VIREMENT", "CHEQUE", "PRELEVEMENT", "CASH", "NATURE" ] }, "contactId": { "type": "string", "maxLength": 36, "format": "uuid" }, "datetime": { "type": "string", "maxLength": 40, "format": "date-time", "nullable": true }, "externalId": { "type": "string", "maxLength": 200 }, "participation": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 } }, "required": [], "additionalProperties": false }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "amount", "method" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": false, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### POST /fundraising-campaigns/{id}/manual-contributions create Fundraising Manual Contribution `createFundraisingManualContribution` Required scope: `fundraising:write`. Also requires `paiements:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "displayName": { "type": "string", "maxLength": 200 }, "comment": { "type": "string", "maxLength": 3000 }, "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "display": { "type": "boolean" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "montant" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:write" } ``` ### PATCH /fundraising-campaigns/{id}/manual-contributions/{childId} update Fundraising Manual Contribution `updateFundraisingManualContribution` Required scope: `fundraising:write`. Also requires `paiements:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "montant": { "type": "number", "minimum": 0.01, "maximum": 10000000, "multipleOf": 0.01 }, "displayName": { "type": "string", "maxLength": 200 }, "comment": { "type": "string", "maxLength": 3000 }, "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "display": { "type": "boolean" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### DELETE /fundraising-campaigns/{id}/manual-contributions/{childId} delete Fundraising Manual Contribution `deleteFundraisingManualContribution` Required scope: `fundraising:write`. Also requires `paiements:write` (both permissions are checked). Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. expectedRevision is required; If-Match is accepted over HTTP. Legacy documents start at revision 0. A conflicting update returns 409. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:write", "additional": [ "paiements:write" ] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` ```json { "in": "header", "name": "If-Match", "schema": { "type": "string" }, "description": "Revision ETag, required here or in body expectedRevision" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false }, "x-unisoft-additional-scopes": [ "paiements:write" ], "x-unisoft-required-mcp-fields": [ "idempotencyKey", "expectedRevision" ], "x-unisoft-scope": "fundraising:write" } ``` ### PATCH /fundraising-campaigns/{id}/participations/{kind}/{childId}/display moderate Fundraising Participation `moderateFundraisingParticipation` Required scope: `fundraising:moderate`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:moderate", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "path", "name": "kind", "required": true, "schema": { "type": "string", "enum": [ "payment", "subscription", "pledge", "manual" ] } } ``` ```json { "in": "path", "name": "childId", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "team": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "source": { "type": "string", "maxLength": 36, "format": "uuid", "nullable": true }, "displayName": { "type": "string", "maxLength": 200 }, "display": { "type": "boolean" }, "comment": { "type": "string", "maxLength": 3000 }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:moderate" } ``` ### POST /fundraising-campaigns/{id}/visits record Fundraising Visit `recordFundraisingVisit` Required scope: `fundraising:checkout`. Every mutation requires an idempotencyKey (body) or Idempotency-Key header. Reusing a key with a different body returns 409. In-flight/uncertain operations must be reconciled; do not retry a payment with a new key. Amounts: payment/checkout amount is an integer in minor units; campaign goals, product montant, pledge montant and manual contribution montant use major units. AMOUNT maps to the historical empty campaign type internally. Matching, pledges, recurring commitments and Gift Aid boost are progress figures, not settled funds. FULL includes campaign entitlement. Other page-capable plans require the CAMPAGNE module. API keys can be restricted to fundraisingCampaignIds; such a key cannot create or duplicate a campaign. Private API keys belong on your site's backend, never in browser JavaScript. Content overlays follow the organisation's enabled languages; the default language is at the root. null removes a secondary-language overlay. Upload images first through /uploads; filenames must belong to this organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "fundraising:checkout", "additional": [] } ``` #### פרמטרים ```json { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 36, "format": "uuid" } } ``` ```json { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string", "maxLength": 200 }, "description": "Required here or in body idempotencyKey" } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "visitorId": { "type": "string", "maxLength": 100 }, "team": { "type": "string", "maxLength": 36, "format": "uuid" }, "source": { "type": "string", "maxLength": 36, "format": "uuid" }, "url": { "type": "string", "maxLength": 2000, "format": "safe-url" }, "idempotencyKey": { "type": "string", "maxLength": 200 }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, "required": [ "visitorId" ], "additionalProperties": false } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": true }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } } ``` ##### HTTP 400 ```json { "description": "Malformed request / missing idempotency key" } ``` ##### HTTP 403 ```json { "description": "Missing permission or campaign entitlement" } ``` ##### HTTP 404 ```json { "description": "Unknown campaign or resource (including another organisation's resource)" } ``` ##### HTTP 409 ```json { "description": "Revision, lifecycle, stock or idempotency conflict" } ``` ##### HTTP 422 ```json { "description": "Validation error, field included" } ``` ##### HTTP 428 ```json { "description": "expectedRevision required" } ``` ##### HTTP 500 ```json { "description": "Unexpected failure; reconcile an uncertain mutation" } ``` #### OpenAPI ```json { "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": true, "warn": false }, "x-unisoft-required-mcp-fields": [ "idempotencyKey" ], "x-unisoft-scope": "fundraising:checkout" } ``` ### GET /email-templates/catalog/variables List supported email variables `list_email_template_variables` Required system scope: `email_template_catalog:read`. Returns the only variables an AI may use. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateVariableCatalogue" } } } } } } ``` ##### HTTP 403 ```json { "description": "CATALOG_SYSTEM_KEY_REQUIRED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_SYSTEM_KEY_REQUIRED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/catalog/assets Upload an image for catalogue emails `upload_catalog_email_template_asset` Required system scope: `email_template_catalog:write`. Accepts PNG, JPEG or WebP as base64, validates the real image bytes and returns a stable HTTPS URL for use in HTML. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogAssetInput" } } } } ``` #### תגובות ##### HTTP 201 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogAsset" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/catalog List catalogue drafts and published templates `list_catalog_email_templates` Required system scope: `email_template_catalog:read`. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### פרמטרים ```json { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "PUBLISHED" ] } } ``` ```json { "name": "language", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 100 } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/catalog Create a complete catalogue draft `create_catalog_email_template` Required system scope: `email_template_catalog:write`. Creates HTML and catalogue metadata together, then returns validation results. The template remains a DRAFT until explicitly published. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogCreateInput" } } } } ``` #### תגובות ##### HTTP 201 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "VALIDATION_ERROR", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "VALIDATION_ERROR" } } } } } } ``` ##### HTTP 403 ```json { "description": "CATALOG_SYSTEM_KEY_REQUIRED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_SYSTEM_KEY_REQUIRED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/catalog/{id} Get a catalogue template and its validation `get_catalog_email_template` Required system scope: `email_template_catalog:read`. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PATCH /email-templates/catalog/{id} Update catalogue metadata `update_catalog_email_template` Required system scope: `email_template_catalog:write`. Returns the template to DRAFT. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogUpdateInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /email-templates/catalog/{id} Delete a catalogue template `delete_catalog_email_template` Required system scope: `email_template_catalog:write`. Soft-deletes the draft or published template. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### PUT /email-templates/catalog/{id}/content Replace catalogue HTML `update_catalog_email_template_content` Required system scope: `email_template_catalog:write`. Returns the template to DRAFT and returns validation results. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateCatalogContentInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:write", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /email-templates/catalog/{id}/validate Validate a catalogue template `validate_catalog_email_template` Required system scope: `email_template_catalog:read`. Checks required metadata, unknown variables, unsubscribe link, unsafe HTML and common email-client layout problems. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateValidation" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/catalog/{id}/preview-link Create a browser preview URL `create_catalog_email_template_preview_link` Required system scope: `email_template_catalog:read`. Returns a signed URL plus the rendered subject/preheader, valid for 1–60 minutes. The authoring preview uses a harmless synthetic organisation and sample recipient values, so the system key never reads client data. It works for DRAFT and PUBLISHED templates, including drafts with validation errors or compatibility warnings. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplatePreviewLinkInput" } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplatePreviewLink" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 503 ```json { "description": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:read", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /email-templates/catalog/{id}/publish Publish a validated catalogue template `publish_catalog_email_template` Required system scope: `email_template_catalog:publish`. Publication is rejected when validation contains any error. Success increments the immutable catalogue version visible to clients. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:publish", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 400 ```json { "description": "CATALOG_VALIDATION_FAILED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_VALIDATION_FAILED" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 409 ```json { "description": "CATALOG_CHANGED_DURING_PUBLICATION", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "CATALOG_CHANGED_DURING_PUBLICATION" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:publish", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /email-templates/catalog/{id}/unpublish Return a catalogue template to draft `unpublish_catalog_email_template` Required system scope: `email_template_catalog:publish`. Removes the template from the client catalogue without deleting it. This global endpoint accepts only the dedicated organisation-less `kc_live_*` catalogue token. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_template_catalog:publish", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_template_catalog:publish", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /email-templates/library Browse published email templates `list_published_email_templates` Required scope: `email_templates:read`. Available to every organisation. Returns only PUBLISHED templates and reports whether the current version was already imported into the caller's organisation. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:read", "additional": [] } ``` #### פרמטרים ```json { "name": "language", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "category", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 100 } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /email-templates/library/{id} Get one published email template `get_published_email_template` Required scope: `email_templates:read`. Returns the published source including its HTML variables. Use the preview-link operation to render it with the current organisation's branding. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplateCatalogItem" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### POST /email-templates/library/{id}/preview-link Preview a published template with my branding `create_published_email_template_preview_link` Required scope: `email_templates:read`. Returns a signed browser URL. The target organisation is always the API key's organisation and cannot be overridden. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:read", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### גוף הבקשה ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "expiresInSeconds": { "type": "integer", "minimum": 60, "maximum": 3600, "default": 900 } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/EmailTemplatePreviewLink" } } } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` ##### HTTP 503 ```json { "description": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "EMAIL_TEMPLATE_PREVIEW_NOT_CONFIGURED" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:read", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### POST /email-templates/library/{id}/import Import a published template into my organisation `import_published_email_template` Required scope: `email_templates:write`. Creates an autonomous AI template in the caller's organisation. All `{{org.*}}` variables are resolved from that organisation; recipient variables remain for send time. Importing the same published version twice is idempotent. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "email_templates:write", "additional": [] } ``` #### פרמטרים ```json { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "description": "Resource id — must be a UUID. A malformed id is rejected with 400 INVALID_UUID (it is not just a 404). Need a fresh one? Call GET /utils/uuid." } ``` #### תגובות ##### HTTP 200 ```json { "description": "Already imported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateImportResult" } } } } ``` ##### HTTP 201 ```json { "description": "Imported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplateImportResult" } } } } ``` ##### HTTP 404 ```json { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "NOT_FOUND" } } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "email_templates:write", "x-unisoft-mcp": { "category": "create", "readOnly": false, "destructive": false, "idempotent": false, "warn": false } } ``` ### GET /wordpress/catalog List the connected organisation's public content `list_wordpress_catalog` Required scope: `wordpress:read`. Authenticated editor-only metadata. Public content is available automatically. resourceAccess is public; the legacy selection field contains all returned IDs for older plugins. Not an anonymous browser endpoint. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "wordpress:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "Public projection only; never donor or submission records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "wordpress:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### PUT /wordpress/selection Save legacy content preferences for older plugins `update_wordpress_selection` Required scope: `wordpress:publish`. The connection also needs wordpress:read. IDs are revalidated against public resources in its organisation. Saved preferences no longer restrict access to public content. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "wordpress:publish", "additional": [] } ``` #### גוף הבקשה ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "selection" ], "properties": { "selection": { "type": "object", "properties": { "donation": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "forms": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "events": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "caisses": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "pages": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "galleries": { "type": "array", "maxItems": 100, "items": { "type": "string" } } } } } } } } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Public projection only; never donor or submission records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` #### OpenAPI ```json { "deprecated": true, "x-unisoft-scope": "wordpress:publish", "x-unisoft-mcp": { "category": "update", "readOnly": false, "destructive": false, "idempotent": true, "warn": false } } ``` ### GET /wordpress/data/{kind} Read public organisation modules `get_wordpress_data` Required scope: `wordpress:read`. Tenant ownership and live public availability are checked on every request. Money uses integer minor units with a currency per collection. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "wordpress:read", "additional": [] } ``` #### פרמטרים ```json { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "donation", "forms", "events", "caisses", "pages", "galleries" ] } } ``` ```json { "name": "id", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "lang", "in": "query", "schema": { "type": "string" } } ``` ```json { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 24 } } ``` #### תגובות ##### HTTP 200 ```json { "description": "Public projection only; never donor or submission records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` ##### HTTP 404 ```json { "description": "Unavailable, inactive, or foreign resource" } ``` #### OpenAPI ```json { "x-unisoft-scope": "wordpress:read", "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### DELETE /wordpress/connection Disconnect this WordPress site `delete_wordpress_connection` Required scope: `wordpress:read`. Removes only this key's publication settings; revokes OAuth tokens, but does not revoke a manually supplied integration key. #### אימות ```json [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ] ``` #### הרשאות נדרשות ```json { "accepted": "wordpress:read", "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "Public projection only; never donor or submission records.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": {} } } } } } ``` #### OpenAPI ```json { "x-unisoft-scope": "wordpress:read", "x-unisoft-mcp": { "category": "delete", "readOnly": false, "destructive": true, "idempotent": true, "warn": false } } ``` ### GET /wordpress/releases/stable Read the signed plugin release manifest `list_wordpress_releases_stable` Public endpoint, independent of account subscription. Automatically builds and caches the deployed source version. Ed25519 signature of a base64-encoded JSON payload. #### אימות ```json [] ``` #### הרשאות נדרשות ```json { "accepted": null, "additional": [] } ``` #### תגובות ##### HTTP 200 ```json { "description": "Signed manifest", "content": { "application/json": { "schema": { "type": "object", "required": [ "signed", "signature" ], "properties": { "signed": { "type": "string" }, "signature": { "type": "string" } } } } } } ``` ##### HTTP 503 ```json { "description": "Release generation temporarily unavailable; retry later" } ``` #### OpenAPI ```json { "x-unisoft-scope": null, "x-unisoft-mcp": { "category": "read", "readOnly": true, "destructive": false, "idempotent": true, "warn": false } } ``` ### סכמות ````json { "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key", "description": "Format: `ke_live_xxx`" }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "schemas": { "Error": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "INVALID_API_KEY" } } }, "Pagination": { "type": "object", "properties": { "nextCursor": { "type": "string", "nullable": true }, "hasMore": { "type": "boolean" }, "count": { "type": "integer" } } }, "Contact": { "type": "object", "description": "A contact (donor / member) of the org. Identity fields are flat; the multi-value sub-collections (secondary addresses / phones / emails, tags, custom fields, family links) are arrays. All `readOnly` fields are computed and are never accepted on write.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "Server-generated UUID. Use it as `{id}` in every sub-resource path." }, "firstName": { "type": "string", "description": "First name. Stored capitalised (« david » → « David »)." }, "lastName": { "type": "string", "description": "Last name / family name. Stored UPPER-CASED (« levy » → « LEVY »)." }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "Gender: \"M\" (male) or \"F\" (female), null = unknown. It is derived from civility on import — never guessed." }, "email": { "type": "string", "description": "Primary email (lower-cased). Extra emails live in `secondaryEmails[]`." }, "phone": { "type": "string", "description": "Primary phone in E.164 (`+33612345678`). Extra numbers live in `secondaryPhones[]`." }, "birthDate": { "type": "string", "format": "date", "nullable": true, "description": "Date of birth, ISO `YYYY-MM-DD`." }, "hebrewFirstName": { "type": "string", "description": "Hebrew first name (prénom hébraïque)." }, "taxId": { "type": "string", "nullable": true, "description": "National / tax identifier (e.g. Israeli Teudat Zehut). Declarative — not validated against a registry." }, "giftAid": { "type": "boolean", "description": "UK Gift Aid eligibility flag. Declarative." }, "address": { "type": "string", "description": "Primary address — street line (flat, no id)." }, "postalCode": { "type": "string", "description": "Primary address — postal / ZIP code." }, "city": { "type": "string", "description": "Primary address — city." }, "region": { "type": "string", "description": "Primary address — state / region / province." }, "country": { "type": "string", "description": "Primary address — country." }, "note": { "type": "string", "nullable": true, "description": "Free note on the primary address." }, "addresses": { "type": "array", "description": "SECONDARY addresses (each with a stable `id` UUID — patchable via PATCH /contacts/{id}/addresses/{addressId}). The primary address is the flat `address`/`postalCode`/`city` above and has NO id.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "label": { "type": "string", "description": "Free label of the address (e.g. « Bureau »)." }, "type": { "type": "string", "nullable": true, "description": "PRO | PERSO (free label)." }, "address": { "type": "string", "description": "Street line." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "companyId": { "type": "string", "nullable": true, "description": "Company registration number (for a PRO address)." }, "note": { "type": "string", "nullable": true } } } }, "secondaryPhones": { "type": "array", "description": "Additional phones (E.164). The primary is `phone`.", "items": { "type": "object", "properties": { "phone": { "type": "string" } } } }, "secondaryEmails": { "type": "array", "description": "Additional emails. The primary is `email`.", "items": { "type": "object", "properties": { "email": { "type": "string" } } } }, "tags": { "type": "array", "description": "Category TAGS — boolean labels (upper-cased & de-accented, e.g. `DONATEUR`, `#FORM`). These are NOT key/value custom fields — see `customFields[]`.", "items": { "type": "string" } }, "customFields": { "type": "array", "description": "Typed key/value custom fields. One entry per key (never duplicated). `type` is one of TEXT/DATE/BOOL only — NUMBER/SELECT are stored as TEXT. Distinct from `tags[]`.", "items": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "key": { "type": "string" }, "type": { "type": "string", "description": "TEXT | DATE | BOOL" }, "value": { "nullable": true, "description": "Stored value (string, ISO date, or boolean)." } } } }, "familyLinks": { "type": "array", "description": "Family relationships. `contactId` = the related contact, `relationship` = SPOUSE/PARENT/CHILD/SIBLING/GRANDPARENT/GRANDCHILD/IN_LAW/EX/COUSIN/FRIEND. Bidirectional (the reverse link is on the other contact).", "items": { "type": "object", "properties": { "relationship": { "type": "string", "enum": [ "SPOUSE", "PARENT", "CHILD", "SIBLING", "GRANDPARENT", "GRANDCHILD", "IN_LAW", "EX", "COUSIN", "FRIEND" ], "nullable": true }, "contactId": { "type": "string", "nullable": true } } } }, "isLocal": { "type": "boolean", "readOnly": true, "description": "Whether the contact is a « local » proximity contact (lives in the org's action zone), set automatically or manually." }, "isLocalSource": { "type": "string", "nullable": true, "readOnly": true, "description": "How `isLocal` was set: AUTO | MANUAL | null." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Creation date." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Last edit date." } } }, "ContactCreateInput": { "type": "object", "description": "Identity of a contact to CREATE or UPSERT. All fields optional — the smallest useful contact is a single `phone` or `email`. Formats: `gender` = \"M\" (male) or \"F\" (female) or null (unknown — NEVER \"Mr\"/\"Mme\"); `phone` accepts a dirty string (« 06 11 22 33 44 »), normalised to E.164; `birthDate` ISO `YYYY-MM-DD`; each `tags` entry is upper-cased/de-accented (« Donateur régulier » → « DONATEUR_REGULIER »). `tags` are boolean labels; `customFields` are typed key/value fields — do not confuse them.", "required": [], "properties": { "firstName": { "type": "string", "description": "First name (stored capitalised)." }, "lastName": { "type": "string", "description": "Last name / family name (stored UPPER-CASED)." }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "\"M\" (male), \"F\" (female) or null (unknown). Never a civility string like \"Mr\"/\"Mme\"." }, "email": { "type": "string", "description": "Primary email. Invalid emails are dropped." }, "phone": { "type": "string", "description": "Primary phone (any format; normalised to E.164). Provide `phoneCountry` for local numbers without a country code." }, "phoneCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code (e.g. \"FR\", \"IL\") used to normalise a local `phone`/`phones` without a `+` prefix." }, "phones": { "type": "array", "items": { "type": "string" }, "description": "Additional (secondary) phones." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Additional (secondary) emails." }, "birthDate": { "type": "string", "format": "date", "description": "Date of birth, ISO `YYYY-MM-DD`. Fill-if-empty on upsert (never overwrites)." }, "hebrewFirstName": { "type": "string", "description": "Hebrew first name." }, "taxId": { "type": "string", "description": "National / tax identifier (e.g. Israeli Teudat Zehut). Declarative." }, "giftAid": { "type": "boolean", "description": "UK Gift Aid flag. Declarative." }, "address": { "type": "string", "description": "Primary street address. If the contact already has a main address, this is added as a secondary one." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "State / region / province." }, "country": { "type": "string", "description": "Country (default \"France\")." }, "note": { "type": "string", "description": "Free note on the primary address." }, "addresses": { "type": "array", "description": "Extra SECONDARY addresses to add.", "items": { "type": "object", "properties": { "label": { "type": "string" }, "type": { "type": "string", "description": "PRO | PERSO" }, "address": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "companyId": { "type": "string", "description": "Company registration number (for a PRO address)." }, "note": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Category tags to attach (each normalised UPPERCASE). On CREATE the first tag is the seed tag; with none, the source tag `#API` is set." }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/ContactFieldEntry" }, "description": "Typed key/value custom fields (upsert-by-key). On create/import these are fill-if-empty (append-only). Distinct from `tags[]`." } } }, "ContactUpdateInput": { "type": "object", "description": "Identity fields to OVERRIDE on an existing contact (explicit edit — replaces the stored value, unlike the fill-if-empty create/upsert). Sub-collections (secondary phones / emails / addresses / tags / custom fields) are NOT touched here — use the dedicated sub-resource endpoints. An empty string (\"\") means « leave untouched » (append-only: identity is never erased). Same formats as ContactCreateInput.", "required": [], "properties": { "firstName": { "type": "string", "description": "Overwrites the first name (capitalised). \"\" = leave untouched." }, "lastName": { "type": "string", "description": "Overwrites the last name (upper-cased). \"\" = leave untouched." }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "\"M\" (male), \"F\" (female) or null (unknown)." }, "email": { "type": "string", "description": "Overwrites the primary email (must be valid → 400 INVALID_EMAIL)." }, "phone": { "type": "string", "description": "Overwrites the primary phone (E.164; 400 INVALID_PHONE if unparseable)." }, "phoneCountry": { "type": "string", "description": "ISO country to normalise a local `phone`." }, "birthDate": { "type": "string", "format": "date", "description": "Overwrites date of birth (ISO). 400 INVALID_DATE if unparseable." }, "hebrewFirstName": { "type": "string", "description": "Overwrites the Hebrew first name." }, "taxId": { "type": "string", "description": "Overwrites the national / tax identifier (Teudat Zehut)." }, "giftAid": { "type": "boolean", "description": "Overwrites the UK Gift Aid flag." }, "address": { "type": "string", "description": "Overwrites the PRIMARY address (street)." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "note": { "type": "string" } } }, "ContactFieldEntry": { "type": "object", "description": "A typed custom field. `type` is reduced to TEXT/DATE/BOOL on storage — NUMBER/SELECT/etc. are stored as TEXT (the round-trip value stays a string).", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "Field key (case-insensitive, `_`↔`-` equivalent). Upsert-by-key: writing the same key twice updates the single existing field, never duplicates it." }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "DATETIME", "BOOL" ], "description": "TEXT | NUMBER | DATE | DATETIME | BOOL. NUMBER/DATETIME are stored as TEXT.", "default": "TEXT" }, "value": { "description": "Field value (string / number / ISO date / boolean)." } } }, "ContactAddressInput": { "type": "object", "description": "An address to add. If the contact has no primary address (or `main:true`), it becomes the primary; otherwise it is added as a deduped secondary address.", "required": [ "address" ], "properties": { "main": { "type": "boolean", "description": "Force this as the PRIMARY address (overwrites the flat one)." }, "label": { "type": "string", "description": "Free label (e.g. « Bureau »)." }, "type": { "type": "string", "description": "PRO | PERSO." }, "address": { "type": "string", "description": "Street address (required)." }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "State / region / province." }, "country": { "type": "string", "description": "Country (default \"France\")." }, "companyId": { "type": "string", "description": "Company registration number (for a PRO address)." }, "note": { "type": "string" } } }, "ContactAddressPatchInput": { "type": "object", "description": "Whitelisted fields to merge into a SECONDARY address (targeted by its `addressId` UUID). Only supplied fields change. The PRIMARY address has no id and cannot be patched here (use PATCH /contacts/{id} or POST /contacts/{id}/addresses with main:true).", "properties": { "label": { "type": "string" }, "type": { "type": "string", "description": "PRO | PERSO." }, "address": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "companyId": { "type": "string" }, "note": { "type": "string" } } }, "ContactPhoneInput": { "type": "object", "description": "A SECONDARY phone to append (deduped). The primary phone is set via POST/PATCH /contacts.", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "Phone (any format; normalised to E.164; 400 INVALID_PHONE if unparseable)." }, "phoneCountry": { "type": "string", "description": "ISO country code to normalise a local number." } } }, "ContactEmailInput": { "type": "object", "description": "A SECONDARY email to append (deduped). The primary email is set via POST/PATCH /contacts.", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "Email (lower-cased; 400 INVALID_EMAIL if invalid)." } } }, "ContactTagsInput": { "type": "object", "description": "One or more category TAGS to attach (idempotent — re-adding a tag is a no-op). Each is normalised (upper-cased, de-accented, spaces → `_`). System tags (#FORM/#PAIEMENT/#ABONNEMENT/#ACCOUNT/currency codes) are allowed too. A tag is a boolean label — NOT a key/value custom field (see ContactCustomFieldsInput).", "required": [ "tags" ], "properties": { "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags, e.g. [\"Donateur\", \"Séder night\"] → stored DONATEUR, SEDER_NIGHT." } } }, "ContactCustomFieldsInput": { "type": "object", "description": "Typed key/value custom fields to upsert-by-key. `override` (default true here — an explicit edit) overwrites the stored value; set it false to only fill empty fields. `type` reduced to TEXT/DATE/BOOL (NUMBER/DATETIME stored as TEXT). Distinct from category tags.", "required": [ "customFields" ], "properties": { "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/ContactFieldEntry" }, "description": "The fields to set (upsert-by-key, never duplicated)." }, "override": { "type": "boolean", "description": "true (default) overwrites an existing value; false only fills empty fields.", "default": true } } }, "ContactFamilyLinkInput": { "type": "object", "description": "A bidirectional family link between the contact and `relatedContactId`. The reverse link is added automatically (PARENT↔CHILD and GRANDPARENT↔GRANDCHILD are asymmetric; the other types are symmetric). `relatedContactId` MUST belong to the same org (else 404).", "required": [ "relationship", "relatedContactId" ], "properties": { "relationship": { "type": "string", "enum": [ "SPOUSE", "PARENT", "CHILD", "SIBLING", "GRANDPARENT", "GRANDCHILD", "IN_LAW", "EX", "COUSIN", "FRIEND" ], "description": "The link FROM this contact TO `relatedContactId`: SPOUSE, PARENT (this contact is the parent → reverse CHILD), CHILD, SIBLING, GRANDPARENT (→ reverse GRANDCHILD), GRANDCHILD, IN_LAW, EX, COUSIN, FRIEND." }, "relatedContactId": { "type": "string", "format": "uuid", "description": "The other contact's id (must belong to the org)." } } }, "ContactInteraction": { "type": "object", "description": "A logged touchpoint with the contact (a call, a visit, a note). Read projection of a `contact_activity` document.", "properties": { "id": { "type": "string", "readOnly": true }, "type": { "type": "string", "description": "Kind of interaction, e.g. « Appel », « Visite »." }, "content": { "type": "string", "description": "Free-text notes." }, "actions": { "type": "array", "items": { "type": "string" }, "description": "Optional string tags describing what was done." }, "author": { "type": "string", "nullable": true, "readOnly": true, "description": "Name of the staff author when the entry came from the admin/copilot; null for API-created entries." }, "datetime": { "type": "string", "format": "date-time", "readOnly": true } } }, "ContactInteractionInput": { "type": "object", "description": "A new interaction to log against the contact. Use it to record a call/visit/note from an automation. Reuse a `type` from GET /contacts/{id}/interactions/types for consistency instead of inventing a new label each time.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Kind of interaction (free label), e.g. « Appel », « Visite », « Rencontre »." }, "content": { "type": "string", "description": "Free-text notes about the interaction." }, "actions": { "type": "array", "items": { "type": "string" }, "description": "Optional string tags, e.g. [« Tefiline », « Discussion »]." } } }, "ContactChildInput": { "type": "object", "description": "A « baby » child to attach to the contact (and its detected SPOUSE) as parents. Deduped by first name against the parents: an existing child is reused (created:false), otherwise a new child contact is created without phone/email. A PARENT↔CHILD link is set automatically.", "required": [ "firstName" ], "properties": { "firstName": { "type": "string", "description": "Child's first name (used for dedup)." }, "lastName": { "type": "string", "description": "Child's last name (upper-cased)." }, "birthDate": { "type": "string", "format": "date", "description": "Date of birth (ISO)." } } }, "ContactDocument": { "type": "object", "description": "A file attached to the contact (a receipt, an ID scan, a signed mandate…). Read projection of a `contact.docs[]` sub-document.", "properties": { "id": { "type": "string", "readOnly": true, "description": "Document id (UUID) — pass it to DELETE /contacts/{id}/documents/{docId}." }, "name": { "type": "string", "nullable": true, "description": "Human label (defaults to the filename if none was given)." }, "filename": { "type": "string", "nullable": true, "readOnly": true, "description": "Hosted filename (md5.ext). Reusable to attach the SAME file elsewhere without re-uploading." }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "Absolute URL to download the file." }, "uploadedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } } }, "ContactDocumentInput": { "type": "object", "description": "Attach a document to the contact. Provide EXACTLY ONE of `filename` (a file already hosted via POST /uploads/pdf|image) or `url` (an http(s) link, re-hosted server-side — image/PDF only, the MCP/AI path). Image & PDF only (a contact document is a scan, not a video). The typical flow is « upload first, place after »: POST /uploads/pdf → take its `filename` → POST here.", "properties": { "filename": { "type": "string", "description": "Hosted filename returned by POST /uploads/pdf or /uploads/image (md5.ext). Must belong to this org." }, "url": { "type": "string", "description": "Public http(s) URL of an image or PDF to download & host. Use this from an MCP/AI agent that cannot stream a binary." }, "name": { "type": "string", "description": "Optional human label for the document (defaults to the filename)." } } }, "ContactNormalizeInput": { "type": "object", "description": "Rows of raw (dirty Excel/CSV) columns to normalise per-column. PURE — no database, no org data touched. Use this FIRST when importing a spreadsheet: it cleans phone→E.164 (+ detected country), email, birthDate→ISO, and civility→gender \"M\"/\"F\", and flags per-row `issues`.", "required": [ "rows" ], "properties": { "rows": { "type": "array", "description": "Each object holds the raw cell values of one spreadsheet row.", "items": { "type": "object", "properties": { "phone": { "type": "string", "description": "Raw phone, e.g. \"06 12 34 56 78\"." }, "email": { "type": "string", "description": "Raw email, e.g. \"David.Levy@GMAIL.com \"." }, "birthDate": { "type": "string", "description": "Raw date of birth, e.g. \"15/03/1990\" (DD/MM/YYYY by default)." }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "gender": { "type": "string", "description": "Raw civility/gender, e.g. \"Mme\", \"Mr\", \"מר\", \"M\", \"F\" → gender \"M\"/\"F\"." }, "category": { "type": "string", "description": "Raw category tag, e.g. \"Séder night\" → SEDER_NIGHT." } } } }, "defaultPhoneCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country (e.g. \"FR\") to normalise local phones without a country code. Default \"ZZ\" (none)." }, "dateFormat": { "type": "string", "description": "Hint for ambiguous dates (e.g. \"M/D/YYYY\" for US files). Dates are parsed with a date-parser, NEVER new Date(). Day-first (DD/MM/YYYY) by default." } } }, "ContactLookupInput": { "type": "object", "description": "Batch dedup — for each item, find the matching contact of the org WITHOUT writing anything. Use it after normalize and before import to know which rows already exist (matchedContactId).", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "description": "Phone to match (normalised to E.164 before lookup)." }, "email": { "type": "string", "description": "Email to match (lower-cased before lookup)." } } } }, "defaultPhoneCountry": { "type": "string", "description": "ISO country to normalise local phones. Default \"ZZ\"." } } }, "ContactImportInput": { "type": "object", "description": "Bulk upsert of up to 500 contacts (500+ → 400 IMPORT_TOO_LARGE; paginate). Set `dryRun:true` to get the per-line PLAN (action + issues) WITHOUT writing anything. Each row is normalised & validated like create_contact; a row with a blocking error is skipped (action:\"error\"). Call get_contact_import_schema first to learn the importable field keys and their aliases.", "required": [ "contacts" ], "properties": { "contacts": { "type": "array", "description": "The rows to import (≤ 500). Each row supports the same public identity fields as ContactCreateInput (firstName/lastName/gender/email/phone/birthDate/tags/customFields/address…), plus an optional `__row` (the source spreadsheet row number, echoed back in the report).", "items": { "allOf": [ { "$ref": "#/components/schemas/ContactCreateInput" }, { "type": "object", "properties": { "__row": { "description": "Original spreadsheet row number, echoed as `report.lines[].row`." } } } ] } }, "options": { "type": "object", "description": "Import options.", "properties": { "dedupStrategy": { "type": "string", "enum": [ "skip", "update", "create" ], "description": "On a match: skip (leave untouched), update (fill-if-empty, default), or create (always insert a new doc).", "default": "update" }, "applyTags": { "type": "array", "items": { "type": "string" }, "description": "Category tags added to EVERY imported contact (normalised UPPERCASE)." }, "defaultPhoneCountry": { "type": "string", "description": "ISO country to normalise local phones. Default \"ZZ\"." }, "dateFormat": { "type": "string", "description": "Hint for ambiguous dates (e.g. \"M/D/YYYY\")." } } }, "dryRun": { "type": "boolean", "description": "true = validate + plan only, NO write. Counters are PROJECTED; `report.lines` shows the action per row.", "default": false } } }, "ContactImportSchema": { "type": "object", "description": "The self-describing import guide: the catalogue of importable fields (each with the aliases to match your spreadsheet columns) and the available import options. Call it FIRST, map your columns onto these field keys, then normalize → lookup → import dryRun → import.", "properties": { "success": { "type": "boolean" }, "fields": { "type": "array", "description": "Every importable public field.", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The public field key to use in normalize/import rows (e.g. \"firstName\", \"phone\", \"tags\")." }, "label": { "type": "string", "description": "Human label." }, "type": { "type": "string", "description": "string | enum | date | boolean | object[]." }, "kind": { "type": "string", "enum": [ "identity", "address", "contact", "tag", "customField" ], "description": "Which part of the contact this field feeds." }, "multi": { "type": "boolean", "description": "Whether the field accepts multiple values (e.g. tags, secondary phones)." }, "example": { "description": "A sample value." }, "description": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "Common FR/EN spreadsheet column headers that map to this field — use them to auto-match your columns." } } } }, "options": { "type": "object", "description": "The import options (dedupStrategy, defaultPhoneCountry, dateFormat, requireContact, applyTags) with their allowed values and defaults, mirroring the import step of the admin ImportPage.", "additionalProperties": true } } }, "ImportResult": { "type": "object", "description": "Import outcome. Same shape for dry-run and real: in dry-run the counters are PROJECTED and nothing is written; `report.lines` is always present (the per-row plan).", "properties": { "success": { "type": "boolean" }, "report": { "type": "object", "properties": { "created": { "type": "integer", "description": "Contacts created (projected in dry-run)." }, "updated": { "type": "integer", "description": "Contacts updated (projected in dry-run)." }, "skipped": { "type": "integer", "description": "Rows skipped (matched + dedupStrategy skip)." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "row": { "description": "__row or index." }, "reason": { "description": "The blocking issues of that row." } } } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "row": {}, "reason": { "type": "string" } } } }, "lines": { "type": "array", "description": "One entry per input row (dry-run AND real).", "items": { "type": "object", "properties": { "row": { "description": "__row (if provided) or the 0-based index." }, "action": { "type": "string", "enum": [ "create", "update", "skip", "error" ], "description": "The planned/performed action. \"error\" = a blocking issue → not written." }, "matchedContactId": { "type": "string", "nullable": true, "description": "The existing contact detected by dedup (null = new)." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "The PUBLIC field of the issue (e.g. \"phone\", \"email\", \"birthDate\")." }, "reason": { "type": "string", "description": "MISSING_IDENTITY | INVALID_PHONE | INVALID_EMAIL | INVALID_DATE | INVALID_BOOL | DUPLICATE_IN_BATCH | UNKNOWN_RELATIONSHIP." }, "severity": { "type": "string", "enum": [ "error", "warning" ], "description": "error blocks the write; warning does not." } } } } } } } } } } }, "NormalizeResult": { "type": "object", "description": "Per-row normalisation result. Read `valid`/`country` per column to decide what to fix before importing.", "properties": { "success": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "phone": { "type": "object", "properties": { "input": { "type": "string" }, "e164": { "type": "string", "nullable": true }, "national": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "valid": { "type": "boolean" } } }, "email": { "type": "object", "properties": { "input": { "type": "string" }, "value": { "type": "string", "nullable": true }, "valid": { "type": "boolean" } } }, "birthDate": { "type": "object", "properties": { "input": { "type": "string" }, "value": { "type": "string", "nullable": true, "description": "ISO date." }, "valid": { "type": "boolean" } } }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "gender": { "type": "string", "enum": [ "M", "F" ], "nullable": true, "description": "Derived from the raw civility/gender column. null if unrecognised." }, "civilityMatched": { "type": "boolean", "description": "Whether the raw civility/gender string was recognised." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Normalised category tags derived from the row." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "severity": { "type": "string" } } } } } } } } }, "LookupResult": { "type": "object", "description": "Batch lookup result. Each item reports the matched contact (if any) without any write.", "properties": { "success": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "matchedContactId": { "type": "string", "nullable": true }, "matchedOn": { "type": "string", "nullable": true, "description": "\"phone\" or \"email\"." }, "matchedName": { "type": "string", "nullable": true } } } }, "summary": { "type": "object", "properties": { "matched": { "type": "integer" }, "unmatched": { "type": "integer" } } } } }, "Paiement": { "type": "object", "description": "A payment (donation, dues, form payment, etc.). Additional fields depend on the payment provider and payment type.", "properties": { "externalRef": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S", "example": "commande-1234", "description": "Optional reference in your system. Non-blank, stored verbatim; exact, case-sensitive matching. Not unique and NOT an idempotency key. Distinct from externalId (import deduplication). Returned on payment reads and payment webhooks when supplied. Recurring payments inherit it." }, "externalMetadata": { "type": "object", "maxProperties": 50, "additionalProperties": { "type": "string", "maxLength": 500 }, "example": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "description": "Optional caller-owned string-to-string map. Up to 50 keys (1–64 characters each), values up to 500 characters. Keys cannot contain . or $ or a NUL character, or equal __proto__, prototype or constructor. Null, arrays, nested objects and non-string values are rejected. Stored verbatim and returned on payment reads and payment webhooks; recurring payments inherit it. Separate from provider metadata; avoid secrets. Neither field is required on historical payments." }, "name": { "type": "string", "nullable": true }, "typeId": { "type": "string", "nullable": true }, "method": { "type": "string" }, "refund": { "type": "object", "description": "Present when a refund has been requested; provider-dependent details. A confirmed refund has state SUCCEEDED.", "properties": { "state": { "type": "string" }, "reason": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "id": { "type": "string" }, "organisation": { "type": "string" }, "state": { "type": "string", "enum": [ "PENDING", "COMPLETED", "FAILED", "REFUNDED", "REFUND_PENDING", "CANCELED" ] }, "type": { "type": "string", "enum": [ "GENERAL", "SERVICE", "CAISSE", "DETTE", "FORM", "CAMPAGNE" ] }, "platform": { "type": "string" }, "amount": { "type": "integer", "description": "Amount in minor units (cents)" }, "devise": { "type": "string", "example": "EUR", "description": "Currency code" }, "contact": { "type": "string", "nullable": true, "description": "Contact id, when identified (not a nested contact object)." }, "info": { "$ref": "#/components/schemas/PaiementInfo" }, "datetime": { "type": "string", "format": "date-time" } } }, "PaiementInfo": { "type": "object", "nullable": true, "description": "Donor identity snapshot stored on the payment (who gave). **Entirely optional** — send `null`, `{}` or omit it for an anonymous / unknown donor; every sub-field is optional too.\n\nStorage rules: if ANY field is filled the object is stored complete (the other fields become empty strings, never null); if ALL are empty it is stored as `null`, which means \"no donor contact\" and suppresses the receipt EMAIL (the receipt document itself is still produced). `email` is the address the receipt is sent to — without it the donor gets no email.\n\nOnly one thing is rejected (400 INVALID_INFO): sending a non-object, e.g. a string or an array. That always indicates an integration mistake (an unparsed JSON string), never a real donor.", "properties": { "nom": { "type": "string", "description": "Last name." }, "prenom": { "type": "string", "description": "First name." }, "email": { "type": "string", "description": "Email the payment receipt is sent to." }, "tel": { "type": "string", "description": "Phone number (E164 preferred)." } } }, "PaiementFacturation": { "type": "object", "nullable": true, "description": "Billing / fiscal identity PRINTED ON THE RECEIPT and the tax receipt (cerfa). **Entirely optional** — send `null`, `{}` or omit it and every field is stored as an empty string (never null), which keeps receipt generation working but prints a receipt with no address. Every sub-field is optional too. ALWAYS fill it when the donation is eligible for a tax receipt, otherwise the document is issued blank and is unusable by the donor.\n\n`perso` is the discriminant: `true` (default) = individual, the receipt is issued to `nom` + `prenom`; `false` = company, the receipt is issued to `raison` — so ALWAYS send `raison` with `perso:false`, otherwise the company receipt is issued with a blank name (accepted, but unusable by the donor). When `perso` is true and `nom`/`prenom` are omitted, they are copied from `info` if present.\n\nTwo things are rejected (400 INVALID_FACTURATION), both of which always indicate an integration mistake rather than a real donation: sending a non-object (a string or array instead of the block), and sending a non-boolean `perso` (e.g. `1`, `0` or `\"yes\"` — these used to be silently read as `true`, issuing an individual receipt to a company). Text fields sent as a boolean are treated as empty, so the word \"false\" can never be printed on a receipt; numbers are accepted and converted (`postal: 75001` → `\"75001\"`).", "properties": { "perso": { "type": "boolean", "default": true, "description": "true = individual (nom/prenom), false = company (raison/siren). Defaults to true." }, "nom": { "type": "string", "description": "Last name on the receipt (individual)." }, "prenom": { "type": "string", "description": "First name on the receipt (individual)." }, "civilite": { "type": "string", "description": "Title (M., Mme…) printed on the tax receipt." }, "raison": { "type": "string", "description": "Company name. REQUIRED when perso is false — it is the only name printed on a company receipt." }, "siren": { "type": "string", "description": "Company registration number (SIREN) printed next to the company name." }, "adresse": { "type": "string", "description": "Street address printed on the receipt and synced to the CRM contact." }, "postal": { "type": "string", "description": "Postal code." }, "ville": { "type": "string", "description": "City." }, "etat": { "type": "string", "description": "State / province. Printed on the CA (Canada) receipt format and synced to the CRM." }, "pays": { "type": "string", "description": "Country name. Used by some payment providers to resolve the ISO country code." }, "social_id": { "type": "string", "description": "National ID (e.g. Teoudat Zehout) — used by the Israeli receipt platforms and synced to the CRM contact." }, "giftAid": { "type": "boolean", "description": "UK only: the donor has agreed to Gift Aid. Sets the Gift Aid flag on the CRM contact so the charity can reclaim the tax relief. Omit it for non-UK donations." } } }, "PaiementImportInput": { "type": "object", "description": "An already-collected donation to record as a HISTORICAL / accounting payment (cheque, wire, cash, a legacy software, another platform). It is stored with `imported:true` and `state:\"COMPLETED\"` (forced server-side): it feeds stats, campaign counters, the CRM and currency conversion, but NO receipt / cerfa is (re)emitted — the donor already got one wherever the money was collected. Use this to migrate historical payments or to log an off-platform donation; use `POST /paiements` instead to make a donor pay online now.", "required": [ "method" ], "properties": { "externalRef": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S", "example": "commande-1234", "description": "Optional reference in your system. Non-blank, stored verbatim; exact, case-sensitive matching. Not unique and NOT an idempotency key. Distinct from externalId (import deduplication). Returned on payment reads and payment webhooks when supplied. Recurring payments inherit it." }, "externalMetadata": { "type": "object", "maxProperties": 50, "additionalProperties": { "type": "string", "maxLength": 500 }, "example": { "registrationId": "inscription-567", "eventId": "chabbat-890" }, "description": "Optional caller-owned string-to-string map. Up to 50 keys (1–64 characters each), values up to 500 characters. Keys cannot contain . or $ or a NUL character, or equal __proto__, prototype or constructor. Null, arrays, nested objects and non-string values are rejected. Stored verbatim and returned on payment reads and payment webhooks; recurring payments inherit it. Separate from provider metadata; avoid secrets. Neither field is required on historical payments." }, "amount": { "type": "integer", "description": "Amount in MINOR units (cents), e.g. 1500 = 15€. Provide THIS or `montant` (not both — `amount` wins). Must be > 0." }, "montant": { "type": "number", "description": "Amount in MAJOR currency units, e.g. 50 = 50€ (like a human types). Converted to cents server-side. Provide THIS or `amount`." }, "method": { "type": "string", "enum": [ "CB", "VIREMENT", "CHEQUE", "PRELEVEMENT", "CASH", "NATURE" ], "description": "Payment instrument. CB = card / online, VIREMENT = wire, CHEQUE = cheque, PRELEVEMENT = direct debit, CASH = cash, NATURE = gift in kind. Human aliases (wire/check/cash…) are accepted and normalised." }, "assoc": { "type": "string", "default": "MAIN", "description": "The org association this donation belongs to — it FIXES the currency and the receipt. Defaults to \"MAIN\". List valid values via GET /associations. The `devise` is always derived from it (never overridable)." }, "contactId": { "type": "string", "description": "Optional CRM contact id (of THIS org) to attach the donation to. No contact is created implicitly — supply an existing id or omit." }, "type": { "type": "string", "enum": [ "GENERAL", "CAMPAGNE", "DETTE", "CAISSE", "FORM" ], "default": "GENERAL", "description": "Attachment kind. GENERAL (default) = a plain donation. Otherwise attach to one of your org's entities via `typeId`: CAMPAGNE (feeds its counter), DETTE (a pledge), CAISSE (a pot), FORM (a submission). The attachment does NOT change the currency (`assoc` does)." }, "typeId": { "type": "string", "description": "Id of the target entity when `type` ≠ GENERAL (campaign / dette / caisse / forms_submit id). Must belong to your organisation." }, "info": { "$ref": "#/components/schemas/PaiementInfo" }, "facturation": { "$ref": "#/components/schemas/PaiementFacturation" }, "commentaire": { "type": "string", "description": "Free-text note kept on the payment." }, "datetime": { "type": "string", "format": "date-time", "description": "Optional. The REAL date the donation was collected, ISO 8601 (\"2024-01-15\" or \"2024-01-15T10:30:00Z\"); defaults to now when omitted. ALWAYS set it when migrating history: this date determines the FISCAL YEAR of the receipt and its numbering sequence, so a wrong value issues the receipt for the wrong year. When provided it must be a valid, non-future date — an unparseable value (e.g. the ambiguous \"15/01/2024\", or free text) is rejected with 400 INVALID_DATETIME rather than silently falling back to today, and a future date is rejected with 400 DATETIME_IN_FUTURE (dates up to 24h ahead are tolerated for client clock skew)." }, "source": { "type": "string", "default": "API_IMPORT", "description": "A label identifying where the payment comes from (e.g. \"HELLOASSO\", \"MY_OLD_SOFTWARE\"). Upper-cased. Defaults to \"API_IMPORT\"." }, "externalId": { "type": "string", "description": "Your own stable reference for this payment in the source system. When provided, the import is IDEMPOTENT: re-sending the same externalId updates the same payment instead of creating a duplicate (safe to retry / re-run a migration). Without it, every call creates a new payment." } } }, "FormSubmit": { "type": "object", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "form": { "type": "string", "description": "Form id" }, "state": { "type": "string" }, "data": { "type": "object" }, "total": { "type": "number", "description": "Expected total of the registration, in MAJOR currency units." }, "devise": { "type": "string", "description": "Currency code." }, "paye": { "type": "number", "readOnly": true, "description": "Amount actually paid (sum of COMPLETED payments), in MAJOR units." }, "reste": { "type": "number", "readOnly": true, "description": "Remaining to pay (max(0, total - paye)), in MAJOR units." }, "paiements": { "type": "array", "readOnly": true, "description": "COMPLETED payments of this submission (amounts in MAJOR units). Only on GET /forms-submit/{id}.", "items": { "type": "object", "properties": { "amount": { "type": "number" }, "method": { "type": "string", "nullable": true }, "datetime": { "type": "string", "format": "date-time" } } } }, "datetime": { "type": "string", "format": "date-time" } } }, "Abonnement": { "type": "object", "description": "A subscription (recurring donation)", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "state": { "type": "string" }, "active": { "type": "boolean" }, "amount": { "type": "integer", "description": "Amount in minor units (cents)" }, "devise": { "type": "string", "description": "Currency code" }, "contact": { "type": "string", "description": "Contact id" }, "datetime": { "type": "string", "format": "date-time" } } }, "Promesse": { "type": "object", "description": "A donation pledge (« promesse de don »): an amount a contact committed to give, that payments progressively fulfil. Stored in dettes_v2.", "properties": { "cerfa": { "type": "boolean", "default": true, "description": "Tax receipt choice for future payments only. Existing payments and documents retain their original treatment." }, "receiptRevision": { "type": "integer", "readOnly": true }, "id": { "type": "string" }, "organisation": { "type": "string" }, "contact": { "type": "string", "description": "Contact id of the donor." }, "contactName": { "type": "string", "readOnly": true, "description": "Donor full name (computed on read)." }, "montant": { "type": "number", "description": "Pledged amount in MAJOR currency units (e.g. 50 = 50€), NOT cents — unlike Paiement.amount." }, "devise": { "type": "string", "description": "Currency code (lower-case, e.g. \"eur\")." }, "assoc": { "type": "string", "description": "Association id the pledge belongs to (\"MAIN\" by default)." }, "name": { "type": "string", "description": "Free-text label of the pledge." }, "type": { "type": "string", "description": "Free-text category/type." }, "occasion": { "type": "string", "description": "Campaign/occasion grouping (free text)." }, "typeId": { "type": "string", "nullable": true, "description": "Id of the livret OR campagne the pledge is attached to (the admin \"Livret\" picker). When it is a campagne, the pledge is counted in that campaign's total; when a livret, in its budget." }, "active": { "type": "boolean" }, "payed": { "type": "number", "readOnly": true, "description": "Amount already paid (major units). Computed from linked payments — never stored." }, "reste": { "type": "number", "readOnly": true, "description": "Remaining amount to pay (major units). Computed — never stored." }, "hasActiveAbonnement": { "type": "boolean", "readOnly": true, "description": "Whether an active subscription is fulfilling this pledge." }, "status": { "type": "string", "readOnly": true, "enum": [ "OPEN", "PARTIAL", "FULFILLED", "COVERED", "CANCELED" ], "description": "Computed lifecycle: OPEN (nothing paid), PARTIAL, FULFILLED (reste<=0), COVERED (an active subscription pays it), CANCELED." }, "datetime": { "type": "string", "format": "date-time", "readOnly": true }, "editDatetime": { "type": "string", "format": "date-time", "readOnly": true } } }, "PromesseCreate": { "type": "object", "required": [ "contactId", "montant" ], "properties": { "cerfa": { "type": "boolean", "default": true, "description": "Tax receipt choice for future payments only. Existing payments and documents retain their original treatment." }, "contactId": { "type": "string", "description": "Donor contact id (must belong to the org)." }, "montant": { "type": "number", "description": "Pledged amount in MAJOR currency units (e.g. 50 = 50€), NOT cents. Must be > 0." }, "name": { "type": "string", "description": "Free-text label of the pledge." }, "occasion": { "type": "string", "description": "Campaign/occasion grouping (free text)." }, "type": { "type": "string", "description": "Free-text category/type." }, "assoc": { "type": "string", "description": "Association the pledge belongs to (\"MAIN\" by default). FIXED at creation — it determines the currency and the receipt, and CANNOT be changed afterwards. List the available associations via GET /associations." }, "typeId": { "type": "string", "description": "Optional id of the livret OR campagne to attach the pledge to (the admin \"Livret\" picker). If it is a campagne, the pledge counts toward that campaign's total; if a livret, toward its budget." } } }, "PromesseUpdate": { "type": "object", "description": "Any subset of these fields. `assoc` and `devise` are NOT editable (fixed at creation). Computed fields (reste/payed/status) are never accepted.", "properties": { "expectedReceiptRevision": { "type": "integer", "minimum": 0, "description": "Receipt revision returned by the last read; rejects a stale fiscal edit." }, "cerfa": { "type": "boolean", "default": true, "description": "Tax receipt choice for future payments only. Existing payments and documents retain their original treatment." }, "contactId": { "type": "string" }, "montant": { "type": "number", "description": "Major currency units, > 0." }, "name": { "type": "string" }, "occasion": { "type": "string" }, "type": { "type": "string" }, "typeId": { "type": "string", "description": "Re-attach to another livret/campagne (or null to detach)." } } }, "PromessePaymentLink": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string", "description": "Hosted payment page URL to fulfil the pledge." }, "reste": { "type": "number", "description": "Remaining amount (major units)." }, "devise": { "type": "string" } } }, "Association": { "type": "object", "description": "A legal association (« association »/cerfa) of the org — determines the currency and the receipt of a donation. Pass its `id` as `assoc` when creating a promesse/paiement.", "properties": { "id": { "type": "string", "description": "Association id to use as `assoc` (\"MAIN\" for the org's main association)." }, "label": { "type": "string", "description": "Display name." }, "devise": { "type": "string", "description": "Currency code of this association (lower-case)." } } }, "FormProduct": { "type": "object", "description": "A product line of a COMPLEX form (purchase item).", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "title": { "type": "string" }, "montant": { "type": "number", "description": "Unit amount in major units (e.g. euros)" }, "cerfa": { "type": "boolean" }, "simple_stock": { "type": "integer", "nullable": true }, "activeReducedPrice": { "type": "boolean" }, "reducedPercent": { "type": "number", "nullable": true }, "reducedExpireAt": { "type": "string", "format": "date-time", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" } }, "position": { "type": "integer" } } }, "FormDefinition": { "type": "object", "description": "Public-facing definition of a form (products, calendars, transpiled HTML).", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "type": { "type": "string", "enum": [ "SIMPLE", "COMPLEX" ] }, "title": { "type": "string" }, "active": { "type": "boolean" }, "withPaiement": { "type": "boolean" }, "autoValid": { "type": "boolean" }, "requirePaiementValidation": { "type": "boolean" }, "content": { "type": "string", "description": "Transpiled HTML when type=SIMPLE." }, "afficheUrl": { "type": "string", "description": "Absolute URL of the poster/cover image shown atop the form (present when set)." }, "aiContentBlockId": { "type": "string", "description": "Id of the AI content block rendered as a rich banner at the top of the form (present when set)." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/FormProduct" } }, "calendars": { "type": "array", "items": { "type": "object" } }, "expired": { "type": "boolean", "description": "True if the linked PE session is no longer active." } } }, "FormAdditionalField": { "type": "object", "description": "A dynamic field added to a form (or to a product). Two scopes: GLOBAL fields (at the form root) appear once per submission; PRODUCT fields (inside a product) repeat per purchased unit. Only collect per-unit info as a product field; everything about the whole order is a global field.", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "TEXT-INPUT", "TEXTAREA-INPUT", "SELECT-INPUT", "CHECKBOX-INPUT", "DOCS-INPUT", "DATE-INPUT", "TITLE", "CONTACT-INPUT", "FREE-AMOUNT-INPUT" ], "description": "Field kind. TEXT-INPUT=free single-line text; TEXTAREA-INPUT=free multi-line text (optional `height` in px); SELECT-INPUT=dropdown (needs `values`); CHECKBOX-INPUT=yes/no; DOCS-INPUT=file upload (needs `doctype`); DATE-INPUT=date/time picker (optional `picker`/`dateFilter`/`range`/`defaultNow`, defaults to a plain date); TITLE=visual separator (no data; uses `__title_tag`+`__text`); CONTACT-INPUT=secondary CRM contact (name+email+phone); FREE-AMOUNT-INPUT=donor-chosen amount (GLOBAL only, requires withPaiement=true, never inside a product)." }, "required": { "type": "boolean", "description": "Whether the field is mandatory." }, "__label": { "type": "string", "description": "Visible label of the field." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Options for SELECT-INPUT (required for that type)." }, "doctype": { "type": "string", "enum": [ "IMG", "PDF", "ZIP" ], "description": "Allowed upload kind for DOCS-INPUT." }, "height": { "type": "integer", "description": "TEXTAREA-INPUT only: fixed height of the text area in pixels (optional)." }, "picker": { "type": "string", "enum": [ "Date & Heure", "Uniquement les Années", "Uniquement les Mois", "Uniquement l'heure" ], "description": "DATE-INPUT only: granularity. Omit for a plain day date (DD/MM/YYYY). \"Date & Heure\"=date+time; \"Uniquement les Années\"=year; \"Uniquement les Mois\"=month; \"Uniquement l'heure\"=time." }, "dateFilter": { "type": "string", "enum": [ "Antérieur à aujourd'hui", "Ultérieur à aujourd'hui", "Aujourd'hui & antérieur à aujourd'hui", "Aujourd'hui & ultérieur à aujourd'hui" ], "description": "DATE-INPUT only: restrict selectable dates relative to today (optional)." }, "range": { "type": "boolean", "description": "DATE-INPUT only: pick a start→end range instead of a single value (optional)." }, "defaultNow": { "type": "boolean", "description": "DATE-INPUT only: pre-fill with the current date/time (optional)." }, "__title_tag": { "type": "string", "enum": [ "h1", "h2", "h3", "h4", "h5" ], "description": "Heading level for TITLE." }, "__text": { "type": "string", "description": "Heading text for TITLE." } } }, "FormProductInput": { "type": "object", "description": "A product line of a form (a buyable item/ticket/option). PRICE VARIATION IS DONE ONLY VIA DISTINCT PRODUCTS — never via tariff options on a single product.", "required": [ "label", "title", "montant" ], "properties": { "id": { "type": "string", "description": "Product id (omit on create; matched by id or label on edit)." }, "label": { "type": "string", "description": "Internal unique label within the form." }, "title": { "type": "string", "description": "Public title shown to the buyer." }, "description": { "type": "string", "description": "Internal description (admin only)." }, "montant": { "type": "number", "description": "Unit price in MAJOR units (e.g. euros). 0 = free. Interpreted monthly when paiementType=MONTHLY." }, "cerfa": { "type": "boolean", "description": "Whether this product is eligible for a tax receipt." }, "active": { "type": "boolean", "description": "Whether the product is active (default true)." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "CRM categories applied to the contact ONLY when this product is selected." }, "simple_stock": { "type": "integer", "description": "Per-product stock limit. Ignored when globalStock is set." }, "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/FormAdditionalField" }, "description": "Per-unit fields, repeated for each quantity bought." } } }, "FormInput": { "type": "object", "description": "Editor business object of a form DEFINITION — the shape you send to create or edit a form, and the shape returned by GET /forms/{id}/edit. A form is a flexible transactional engine: a submission may be a ticketing order, a multi-product purchase, a family registration, a donation, etc. Distinguish the PAYER (who submits) from BENEFICIARIES (via product additionalFields). On a partial PATCH, omit `products`/`additionalFields` to leave them as-is; send them to replace the whole set.", "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Public form title (required)." }, "url": { "type": "string", "description": "Public slug (lowercase, no accents, spaces→\"-\"). Optional." }, "description": { "type": "string", "description": "Internal description (admin only)." }, "afficheUrl": { "type": "string", "description": "Poster/cover image URL or hosted filename shown at the top of the form. Adds WhatsApp share metadata. Send \"\" to remove it. Coexists with aiContentBlockId (both may be set)." }, "aiContentBlockId": { "type": "string", "nullable": true, "description": "Id of an AI content block (ai_content_blocks) rendered as a rich HTML banner at the very top of the form, above the identity fields. Optional — omit to leave unchanged, send \"\"/null to remove. Independent from afficheUrl (the poster image): a form may show both." }, "autoValid": { "type": "boolean", "description": "true = submissions auto-validated; false = manual validation." }, "withPaiement": { "type": "boolean", "description": "Enable online payment. When false, all payment fields below are ignored." }, "paiementType": { "type": "string", "enum": [ "PAIEMENT", "ABONNEMENT", "MONTHLY" ], "description": "Billing model: PAIEMENT=one-off; ABONNEMENT=limited instalments; MONTHLY=recurring monthly. Requires withPaiement=true." }, "onePaiement": { "type": "boolean", "description": "Force a single payment (no deposit). Only with paiementType=PAIEMENT." }, "deposit": { "type": "number", "description": "Fixed deposit amount. paiementType=PAIEMENT and onePaiement=false." }, "depositPercent": { "type": "number", "description": "Deposit as a percentage (0-100). Same dependency as `deposit`." }, "abonnementMaxMonth": { "type": "integer", "description": "Max number of instalments (≥2). paiementType=ABONNEMENT." }, "aboMonthInfinite": { "type": "boolean", "description": "Subscription with no end. paiementType=MONTHLY." }, "aboMonthMin": { "type": "integer", "description": "Min subscription months (≥1). MONTHLY + aboMonthInfinite=false." }, "aboMonthMax": { "type": "integer", "description": "Max subscription months (≥ aboMonthMin). MONTHLY + aboMonthInfinite=false." }, "paiementMethods": { "type": "array", "items": { "type": "string" }, "description": "Alternative manual methods, e.g. [\"CHEQUE\",\"VIREMENT\",\"ESPECES\"]." }, "requirePaiementValidation": { "type": "boolean", "description": "Validation conditioned on online payment. Requires withPaiement=true." }, "autoValidOtherPaiementMethod": { "type": "boolean", "description": "Auto-validate alternative-method payments. Requires requirePaiementValidation=true." }, "allowZeroAmount": { "type": "boolean", "description": "Allow a submission whose total is 0." }, "identity": { "type": "string", "enum": [ "SIMPLE" ], "description": "Contact identification level. SIMPLE = full name + email + phone." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "CRM categories auto-applied to every contact who submits." }, "globalStock": { "type": "integer", "nullable": true, "description": "Shared stock that overrides per-product stocks." }, "allowNoProduct": { "type": "boolean", "description": "Allow submitting without selecting any product." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/FormProductInput" }, "description": "Buyable items. Use distinct products for distinct prices." }, "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/FormAdditionalField" }, "description": "Global custom fields (once per submission)." } } }, "Caisse": { "type": "object", "description": "A caisse (« cagnotte » / fundraising pot) as read back, enriched with collected totals.", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "name": { "type": "string", "description": "Public name of the pot." }, "label": { "type": "string", "description": "Internal label." }, "objectif": { "type": "number", "description": "Fundraising goal in MAJOR units (e.g. euros)." }, "withObjectif": { "type": "boolean", "description": "Whether a goal progress bar is shown." }, "marge": { "type": "number", "description": "Fee/margin applied." }, "bgimage": { "type": "string", "nullable": true, "description": "Background image (hosted filename)." }, "assoc": { "type": "string", "description": "Legal association id (\"MAIN\" or a UUID)." }, "typeId": { "type": "string", "description": "Livret/PE link; equals the caisse id when standalone." }, "active": { "type": "boolean" }, "paused": { "type": "boolean" }, "archived": { "type": "boolean" }, "cerfa": { "type": "boolean", "description": "Whether donations into this pot issue a tax receipt (default true)." }, "url": { "type": "string", "description": "Custom public URL slug of the caisse page." }, "hidden": { "type": "boolean", "description": "Hide the pot from public listings." }, "presetButtons": { "type": "array", "items": { "type": "object" }, "description": "Preset donation amounts shown to donors." }, "imagesCaroussel": { "type": "array", "items": { "type": "string" }, "description": "Image carousel (hosted filenames)." }, "textContent": { "type": "string", "description": "Rich text content of the page." }, "youtubeId": { "type": "string", "description": "YouTube video id shown on the page." }, "aiContentBlockId": { "type": "string", "description": "Linked AI content block id." }, "pe": { "type": "string", "nullable": true, "description": "Parcours d'Événement session id this caisse is attached to." }, "payed": { "type": "number", "readOnly": true, "description": "Total collected so far (computed)." }, "reste": { "type": "number", "readOnly": true, "description": "Remaining to reach the goal (computed)." }, "datetime": { "type": "string", "format": "date-time" } } }, "CaisseInput": { "type": "object", "description": "Payload to create or edit a caisse. On a partial PATCH only the supplied fields change.", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Public name of the pot (required on create)." }, "label": { "type": "string", "description": "Internal label (defaults to name)." }, "objectif": { "type": "number", "description": "Fundraising goal in MAJOR units (e.g. euros)." }, "withObjectif": { "type": "boolean", "description": "Show a goal progress bar." }, "marge": { "type": "number", "description": "Fee/margin applied (default 0)." }, "bgimage": { "type": "string", "description": "Background image: http(s) URL (re-hosted server-side) or an already-hosted filename." }, "assoc": { "type": "string", "description": "Legal association id (default \"MAIN\")." }, "typeId": { "type": "string", "description": "Livret/PE id to attach the caisse to, or \"AUTO\" for a standalone pot (links to itself)." }, "cerfa": { "type": "boolean", "description": "Whether donations into this pot issue a tax receipt (default true)." }, "url": { "type": "string", "description": "Custom public URL slug of the caisse page." }, "hidden": { "type": "boolean", "description": "Hide the pot from public listings." }, "presetButtons": { "type": "array", "items": { "type": "object" }, "description": "Preset donation amounts shown to donors." }, "imagesCaroussel": { "type": "array", "items": { "type": "string" }, "description": "Image carousel: each entry is an http(s) URL (re-hosted) or an already-hosted filename." }, "textContent": { "type": "string", "description": "Rich text content of the page." }, "youtubeId": { "type": "string", "description": "YouTube video id shown on the page." }, "aiContentBlockId": { "type": "string", "description": "Linked AI content block id." }, "pe": { "type": "string", "description": "Parcours d'Événement session id to attach this caisse to." } } }, "Page": { "type": "object", "description": "A custom website page. Addressed by `route` (slug segments) — `url` is the joined form. Content is either AI (`html`+`i18n`+`mainLang`) or legacy visual-editor (`content`); `aiEditable` says whether the content can be written via this API.", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "type": { "type": "string", "enum": [ "MAIN_PAGE", "CUSTOM_PAGE" ], "description": "MAIN_PAGE = a legacy home page (URL locked; no longer created automatically); CUSTOM_PAGE = a normal page." }, "editorType": { "type": "string", "enum": [ "AI", "EDITOR" ], "description": "Which editor owns the content: \"AI\" (html + data-i18n, the only kind this API can write) or \"EDITOR\" (legacy visual editor). Pages created via this API are always \"AI\"." }, "label": { "type": "string", "description": "Internal label." }, "title": { "type": "string", "description": "Public page title." }, "description": { "type": "string", "description": "Page description; used as an automatic SEO fallback when no page/site SEO description is set." }, "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." }, "fr": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "en": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "he": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "it": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "ru": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "pt": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "de": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "es": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "gr": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "ro": { "type": "object", "nullable": true, "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } }, "additionalProperties": true, "description": "Translated page fields, including SEO overrides. Other translated page content can also be present." }, "route": { "type": "array", "items": { "type": "string" }, "description": "URL path as slug segments (e.g. [\"infos\",\"horaires\"])." }, "url": { "type": "string", "readOnly": true, "description": "Joined route (\"infos/horaires\"). Read-only convenience field." }, "active": { "type": "boolean" }, "html": { "type": "string", "description": "AI content HTML (with data-i18n attributes). Present on AI pages." }, "mainLang": { "type": "string", "nullable": true, "description": "Default language of the HTML content." }, "i18n": { "type": "object", "description": "Translations: { lang: { i18nKey: value } } for the data-i18n keys in the HTML.", "additionalProperties": true }, "aiEditable": { "type": "boolean", "readOnly": true, "description": "Whether the page content can be written via PUT /pages/{id}/content (false for legacy visual-editor pages)." }, "datetime": { "type": "string", "format": "date-time" } } }, "PageSeoOverlay": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Partial SEO translation for an enabled alternate language. The organisation's default language stays at the root. Only supplied fields change. Null or an empty object clears this language's SEO only, preserving its other translated page content; clearing stale SEO remains allowed after a language is disabled. Fields accept null/empty strings to restore fallback. Distinct from HTML i18n dictionaries.", "properties": { "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." } } }, "PageInput": { "type": "object", "description": "Payload to create or edit a page's metadata and SEO (metaTitle/metaDescription/metaImage). A page created here is an AI page (its content can then be set via PUT /pages/{id}/content). On a partial PATCH only supplied fields change, including inside a language overlay. Editing SEO works on AI and legacy pages. The default language stays at the root; alternate enabled languages use overlays. SEO fields override site defaults independently; null/empty fields restore fallback. This is separate from HTML data-i18n translations.", "required": [ "title", "url" ], "properties": { "label": { "type": "string", "description": "Internal label." }, "title": { "type": "string", "description": "Public page title (required on create)." }, "description": { "type": "string", "description": "Page description; automatic SEO fallback when no page/site SEO description is set." }, "metaTitle": { "type": "string", "nullable": true, "description": "Page-specific SEO and sharing title; overrides the site default without changing the visible page title. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaDescription": { "type": "string", "nullable": true, "description": "Page-specific meta and sharing description; overrides the site default. Null or an empty string clears the override and restores the site/automatic fallback." }, "metaImage": { "type": "string", "nullable": true, "description": "Page-specific sharing image: HTTP(S) URL (re-hosted server-side) or an already-hosted filename, including translated images. Null or an empty string clears the override and restores the site/automatic fallback." }, "fr": { "$ref": "#/components/schemas/PageSeoOverlay" }, "en": { "$ref": "#/components/schemas/PageSeoOverlay" }, "he": { "$ref": "#/components/schemas/PageSeoOverlay" }, "it": { "$ref": "#/components/schemas/PageSeoOverlay" }, "ru": { "$ref": "#/components/schemas/PageSeoOverlay" }, "pt": { "$ref": "#/components/schemas/PageSeoOverlay" }, "de": { "$ref": "#/components/schemas/PageSeoOverlay" }, "es": { "$ref": "#/components/schemas/PageSeoOverlay" }, "gr": { "$ref": "#/components/schemas/PageSeoOverlay" }, "ro": { "$ref": "#/components/schemas/PageSeoOverlay" }, "url": { "type": "string", "description": "Page URL, e.g. \"infos/horaires\" (required on create). Normalised server-side into slug segments; must be unique and not collide with a built-in page. The home page's URL cannot be changed." }, "active": { "type": "boolean", "description": "Whether the page is published (default true)." } } }, "PageContentInput": { "type": "object", "description": "HTML content for an AI page. Send PLAIN HTML — you do NOT manage translation keys yourself. The server post-processes the HTML and injects a `data-i18n=\"\"` attribute on every translatable text node that lacks one (and `data-i18n-alt`/`-title`/`-placeholder`/`-aria-label` for those attributes), auto-generating keys like `auto_1`. The text in `mainLang` becomes the reference dictionary; existing translations for other languages are preserved and stale keys pruned. To translate, read the page back to get the keys, then POST /pages/{id}/translations with `{lang, dict:{key:value}}`. Refused with PAGE_CONTENT_NOT_EDITABLE on legacy pages.", "required": [ "html" ], "properties": { "html": { "type": "string", "description": "The page HTML (a fragment or full document). data-i18n keys are added automatically." }, "mainLang": { "type": "string", "description": "Language the HTML is written in (e.g. \"fr\"). Defaults to the page's current mainLang or the org default." }, "assets": { "type": "array", "items": { "type": "string" }, "description": "Optional asset filenames referenced by the HTML." } } }, "PageTranslationsInput": { "type": "object", "description": "Translations for one language of an AI page's existing data-i18n keys. Does not change the HTML. Read the page (its `i18n` + the `data-i18n` keys in `html`) to discover the keys.", "required": [ "lang", "dict" ], "properties": { "lang": { "type": "string", "description": "Target language code (e.g. \"en\", \"he\")." }, "dict": { "type": "object", "description": "{ i18nKey: translatedValue }.", "additionalProperties": { "type": "string" } } } }, "ContentBlock": { "type": "object", "description": "A reusable AI content block: a standalone HTML fragment rendered on the public site wherever its `id` is referenced (e.g. the tourism home page via the travel config `homepage.aiContentBlockId`, or a multi-session event group intro). Carries the HTML with `data-i18n` keys plus the `i18n` dictionary of their translations.", "properties": { "id": { "type": "string" }, "organisation": { "type": "string" }, "html": { "type": "string", "description": "The block HTML fragment (with data-i18n attributes)." }, "mainLang": { "type": "string", "nullable": true, "description": "Default language the HTML is written in." }, "i18n": { "type": "object", "description": "Translations: { lang: { i18nKey: value } } for the data-i18n keys in the HTML.", "additionalProperties": true }, "assets": { "type": "array", "items": { "type": "string" }, "description": "Asset filenames referenced by the HTML." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "datetime": { "type": "string", "format": "date-time", "readOnly": true } } }, "ContentBlockContentInput": { "type": "object", "description": "HTML content for an AI content block. Send PLAIN HTML — you do NOT manage translation keys yourself:\nthe server injects a `data-i18n=\"\"` attribute on every translatable text node that lacks one\n(and `data-i18n-alt`/`-title`/`-placeholder`/`-aria-label` for those attributes), auto-generating keys\nlike `auto_1`. The text in `mainLang` becomes the reference dictionary; existing translations for other\nlanguages are preserved and stale keys pruned (so KEEP existing data-i18n keys when re-editing).\nThe block is rendered wherever its id is referenced (e.g. the tourism home page).\n\nAUTHORING RULES the HTML MUST follow (same as the in-app AI editor, since there is no editor to enforce them here):\n• Output a FRAGMENT only — NO , , or ; start directly with
/
/
.\n• Wrap everything in a centred container: max-width:1200px; margin:0 auto; lateral padding 24px desktop / 16px mobile.\n• Prefix ALL CSS classes with `.aicb-` (e.g. .aicb-hero, .aicb-card) to avoid clashing with the host page.\n• NEVER use the viewport height units vh/vmin/vmax (the block renders in an auto-height iframe → infinite loop);\n use px/rem or min-height:600px for hero sections. vw (width) is allowed.\n• Put