{"openapi":"3.0.3","info":{"title":"שיג ושיח Connect API","version":"0.23.1","description":"שיג ושיח Connect - חיבור API ״לא רשמי״ ל-WhatsApp, מבית שיג ושיח. יצירה וחיבור QR, הודעות ומדיה, שיחות ואנשי קשר, קבוצות, פרופיל והגדרות. כל מפתח קשור לסביבת עבודה אחת ולחיבורים המורשים לחשבון. הרשאות נוספות מחייבות יצירת מפתח חדש עם הבחירה המתאימה.\n\nAuthorization: Bearer YOUR_PORTAL_KEY. Rate limit: 60 requests/minute/key. IDs are portal IDs. Scope and current account permissions are checked on every request. Accepted is not a delivery receipt. Mutating operations use Idempotency-Key except short-lived QR pairing.","contact":{"name":"שיג ושיח","email":"support@cig.chat"},"license":{"name":"שירות שיג ושיח"}},"servers":[{"url":"https://connections.cig.chat/api/v1"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Portal API key (ep_live_...). Paste only the key, without the Bearer prefix. Use a key created under /integrations."}},"schemas":{"Receipt":{"type":"object","required":["request_id","status"],"properties":{"request_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"message_id":{"type":"string"},"message":{"type":"string"}}},"Instance":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"security":[{"bearerAuth":[]}],"paths":{"/instances":{"get":{"operationId":"listInstances","summary":"רשימת החיבורים המורשים","responses":{"200":{"description":"Authorized instances","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"}}},"instances":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}},"example":{"workspace":{"id":1,"name":"סביבת עבודה לדוגמה","slug":"demo"},"instances":[{"id":1,"name":"שירות לקוחות"}]}}}},"400":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked portal key. User access may have changed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"WWW-Authenticate":{"schema":{"type":"string"},"example":"Bearer"}}},"403":{"description":"The key scope or current user role does not allow this operation.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Resource absent or outside the workspace/instance allowed by this key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"429":{"description":"60 requests/minute/key exceeded. Wait before retrying.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"example":60}}},"500":{"description":"The request could not be completed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"502":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"503":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"tags":["Connections"],"x-required-scopes":["instances:read"],"description":"Returns portal IDs and display names only. Unassigned instances and other workspaces are excluded. Use the returned integer id in subsequent requests; never use an upstream instance name."},"post":{"operationId":"createInstance","tags":["Connections"],"summary":"יצירת חיבור בסביבת עבודה","description":"Creates in the workspace bound to this key. Requires a workspace-wide key and workspace admin role. Quota and server permissions apply. Choose server_id from GET /creation-servers; omit to use an authorized default. An uncertain creation reserves quota until reviewed in the portal.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","instances:create"],"x-mutating":true,"responses":{"200":{"description":"Previously completed action; no repeated upstream action.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"id":2,"name":"שירות לקוחות"}}}}},"201":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"id":2,"name":"שירות לקוחות"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":100},"server_id":{"type":"string","minLength":1,"maxLength":80}},"required":["name"]},"example":{"name":"שירות לקוחות"}}}}}},"/instances/{id}/status":{"get":{"operationId":"getInstanceStatus","summary":"מצב חיבור ל-WhatsApp","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Status","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"state":{"type":"string","enum":["open","close","connecting","unknown"]},"checked_at":{"type":"string","format":"date-time"}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"state":"open","checked_at":"2026-10-12T09:00:00Z"}}}},"400":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked portal key. User access may have changed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"WWW-Authenticate":{"schema":{"type":"string"},"example":"Bearer"}}},"403":{"description":"The key scope or current user role does not allow this operation.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Resource absent or outside the workspace/instance allowed by this key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"429":{"description":"60 requests/minute/key exceeded. Wait before retrying.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"example":60}}},"500":{"description":"The request could not be completed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"502":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"503":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"tags":["Connections"],"x-required-scopes":["instances:read"],"description":"open: connected; close: disconnected; connecting: pairing or reconnecting; unknown: unrecognized upstream state. Permissions are checked again after the upstream request."}},"/instances/{id}/messages/text":{"post":{"operationId":"sendText","summary":"שליחת הודעת טקסט","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"description":"Unique event identifier, reused unchanged when retrying this exact event.","example":"order-123-confirmation"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["to","text"],"properties":{"to":{"type":"string","pattern":"^\\+?[1-9]\\d{7,14}$"},"text":{"type":"string","minLength":1,"maxLength":4096}}},"example":{"to":"972501234567","text":"העדכון שלך מוכן"}}}},"responses":{"200":{"description":"Previously accepted request, not sent again","content":{"application/json":{"schema":{"type":"object","required":["request_id","status"],"properties":{"request_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"message_id":{"type":"string"},"message":{"type":"string"}}}}},"headers":{"Idempotency-Replayed":{"schema":{"type":"string","enum":["true"]}}}},"202":{"description":"Accepted by the messaging service","content":{"application/json":{"schema":{"type":"object","required":["request_id","status"],"properties":{"request_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"message_id":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","message_id":"EXAMPLE_MESSAGE_ID"}}}},"400":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked portal key. User access may have changed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"WWW-Authenticate":{"schema":{"type":"string"},"example":"Bearer"}}},"402":{"description":"The paid service period has ended. Contact the workspace owner.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"403":{"description":"The key scope or current user role does not allow this operation.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Resource absent or outside the workspace/instance allowed by this key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"409":{"description":"Pending, uncertain, busy or reused idempotency key","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["request_id","status"],"properties":{"request_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"message_id":{"type":"string"},"message":{"type":"string"}}},{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}]}}}},"415":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"422":{"description":"Upstream rejected this request; retries of the same key will not resend","content":{"application/json":{"schema":{"type":"object","required":["request_id","status"],"properties":{"request_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"message_id":{"type":"string"},"message":{"type":"string"}}}}}},"429":{"description":"60 requests/minute/key exceeded. Wait before retrying.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"example":60}}},"500":{"description":"The request could not be completed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"502":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"503":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"tags":["Messages"],"x-required-scopes":["instances:read","messages:send"],"description":"Requires messages:send and a current operate permission on this instance, plus an active paid subscription when applicable. Only to and text are accepted. An Idempotency-Key belongs to one key and one event, with the same recipient and content on every retry. No automatic resend after an uncertain result.","x-mutating":true}},"/requests/{id}":{"get":{"operationId":"getSendRequest","summary":"בדיקת תוצאת בקשת שליחה","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Send status","content":{"application/json":{"schema":{"type":"object","required":["request_id","status"],"properties":{"request_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"message_id":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"תוצאת השליחה אינה ודאית. יש לבדוק את השיחה לפני יצירת בקשה חדשה."}}}},"400":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked portal key. User access may have changed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"WWW-Authenticate":{"schema":{"type":"string"},"example":"Bearer"}}},"403":{"description":"The key scope or current user role does not allow this operation.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Resource absent or outside the workspace/instance allowed by this key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"429":{"description":"60 requests/minute/key exceeded. Wait before retrying.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"example":60}}},"500":{"description":"The request could not be completed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"502":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"503":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}},"tags":["Requests"],"x-required-scopes":["instances:read","messages:send"],"description":"Only the exact key that created the request can read it. accepted means upstream accepted, not delivery or read confirmation. pending/uncertain must be reviewed before sending a new event."}},"/creation-servers":{"get":{"operationId":"creationServers","tags":["Connections"],"summary":"שרתים מורשים ליצירה","description":"Only servers allowed for this user. No addresses or server credentials are returned.","parameters":[],"x-required-scopes":["instances:read","instances:create"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"servers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"default":{"type":"boolean"}}}}}},"example":{"servers":[{"id":"bk","name":"שרת ברירת המחדל","default":true}]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}}},"/instances/{id}/connect":{"post":{"operationId":"connectInstance","tags":["Connections"],"summary":"חיבור WhatsApp וסריקת QR","description":"Starts pairing and returns a short-lived QR if one is available. Scan from WhatsApp > Linked devices. This is POST because pairing changes connection state. It does not consume another plan slot.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","instances:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"data":{"type":"object","properties":{"base64":{"type":"string"},"pairingCode":{"nullable":true},"code":{"type":"string"},"count":{"type":"number"}}}}},"example":{"status":"accepted","data":{"base64":"data:image/png;base64,...","pairingCode":null,"code":"EXAMPLE_QR","count":1}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{},"required":[]},"example":{}}}}}},"/instances/{id}/restart":{"post":{"operationId":"restartInstance","tags":["Connections"],"summary":"הפעלה מחדש של חיבור","description":"Restarts the connection. The linked phone may reconnect.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","instances:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{},"required":[]},"example":{}}}}}},"/instances/{id}/logout":{"post":{"operationId":"logoutInstance","tags":["Connections"],"summary":"ניתוק המספר מ-WhatsApp","description":"Requires confirm: DISCONNECT. This changes the live connection. Deleting removes the portal assignment only after upstream confirms success. Keep the same Idempotency-Key when retrying.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","instances:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"confirm":{"type":"string","enum":["DISCONNECT"]}},"required":["confirm"]},"example":{"confirm":"DISCONNECT"}}}}}},"/instances/{id}":{"delete":{"operationId":"deleteInstance","tags":["Connections"],"summary":"מחיקת חיבור ושחרור המכסה","description":"Requires confirm: DISCONNECT. This changes the live connection. Deleting removes the portal assignment only after upstream confirms success. Keep the same Idempotency-Key when retrying.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","instances:delete"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"confirm":{"type":"string","enum":["DISCONNECT"]}},"required":["confirm"]},"example":{"confirm":"DISCONNECT"}}}}}},"/instances/{id}/presence":{"post":{"operationId":"setPresence","tags":["Connections"],"summary":"מצב זמינות","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","instances:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"presence":{"type":"string","enum":["available","unavailable"]}},"required":["presence"]},"example":{"presence":"available"}}}}}},"/instances/{id}/messages/send":{"post":{"operationId":"sendTextAdvanced","tags":["Messages"],"summary":"שליחת טקסט למספר או לקבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"text":{"type":"string","minLength":1,"maxLength":4096}},"required":["number","text"]},"example":{"number":"972501234567","text":"שלום מצוות השירות"}}}}}},"/instances/{id}/messages/media":{"post":{"operationId":"sendMedia","tags":["Messages"],"summary":"שליחת תמונה, וידאו או מסמך","description":"Media is supplied as raw Base64, up to 5 MiB. The example is a format example, not a usable document. Use the actual file bytes. External media URLs are intentionally not fetched.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"mediatype":{"type":"string","enum":["image","video","document","audio"]},"media":{"type":"string","minLength":1,"maxLength":6990508,"format":"base64","description":"Raw Base64, up to 5 MiB decoded. URLs and data: prefixes are not accepted.","example":"JVBERi0xLjQK"},"mimetype":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9.+-]+/[a-zA-Z0-9.+-]+$"},"caption":{"type":"string","minLength":0,"maxLength":4096},"fileName":{"type":"string","minLength":1,"maxLength":180,"pattern":"^[^/\\\\\\x00-\\x1f]+$"}},"required":["number","mediatype","media","mimetype"]},"example":{"number":"972501234567","mediatype":"document","media":"JVBERi0xLjQK","mimetype":"application/pdf","fileName":"example.pdf"}}}}}},"/instances/{id}/messages/audio":{"post":{"operationId":"sendAudio","tags":["Messages"],"summary":"שליחת הודעה קולית","description":"Supply the actual file as raw Base64, up to 5 MiB. No remote URLs. File conversion and format support depend on the messaging server.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"audio":{"type":"string","minLength":1,"maxLength":6990508,"format":"base64","description":"Raw Base64, up to 5 MiB decoded. URLs and data: prefixes are not accepted.","example":"JVBERi0xLjQK"}},"required":["number","audio"]},"example":{"number":"972501234567","audio":"UklGRg=="}}}}}},"/instances/{id}/messages/sticker":{"post":{"operationId":"sendSticker","tags":["Messages"],"summary":"שליחת מדבקה","description":"Supply the actual file as raw Base64, up to 5 MiB. No remote URLs. File conversion and format support depend on the messaging server.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"sticker":{"type":"string","minLength":1,"maxLength":6990508,"format":"base64","description":"Raw Base64, up to 5 MiB decoded. URLs and data: prefixes are not accepted.","example":"JVBERi0xLjQK"}},"required":["number","sticker"]},"example":{"number":"972501234567","sticker":"UklGRg=="}}}}}},"/instances/{id}/messages/location":{"post":{"operationId":"sendLocation","tags":["Messages"],"summary":"שליחת מיקום","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"name":{"type":"string","minLength":1,"maxLength":100},"address":{"type":"string","minLength":1,"maxLength":200}},"required":["number","latitude","longitude"]},"example":{"number":"972501234567","latitude":32.08,"longitude":34.78,"name":"המשרד"}}}}}},"/instances/{id}/messages/contacts":{"post":{"operationId":"sendContact","tags":["Messages"],"summary":"שליחת כרטיסי אנשי קשר","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"contact":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"fullName":{"type":"string","minLength":1,"maxLength":100},"wuid":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"phoneNumber":{"type":"string","minLength":1,"maxLength":20,"pattern":"^\\+?[1-9][0-9]{7,14}$"},"organization":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","minLength":1,"maxLength":200}},"required":["fullName","wuid","phoneNumber"]},"minItems":1,"maxItems":10}},"required":["number","contact"]},"example":{"number":"972501234567","contact":[{"fullName":"צוות השירות","wuid":"972501234567","phoneNumber":"+972501234567"}]}}}}}},"/instances/{id}/messages/reaction":{"post":{"operationId":"sendReaction","tags":["Messages"],"summary":"תגובה להודעה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","minLength":1,"maxLength":250},"fromMe":{"type":"boolean"},"remoteJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"},"participant":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"}},"required":["id","fromMe","remoteJid"]},"reaction":{"type":"string","minLength":0,"maxLength":32}},"required":["key","reaction"]},"example":{"key":{"id":"EXAMPLE_MESSAGE_ID","fromMe":false,"remoteJid":"972501234567@s.whatsapp.net"},"reaction":"👍"}}}}}},"/instances/{id}/messages/poll":{"post":{"operationId":"sendPoll","tags":["Messages"],"summary":"שליחת סקר","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"name":{"type":"string","minLength":1,"maxLength":200},"selectableCount":{"type":"integer","minimum":1,"maximum":12},"values":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":2,"maxItems":12}},"required":["number","name","selectableCount","values"]},"example":{"number":"972501234567","name":"מה מתאים לך?","selectableCount":1,"values":["בוקר","ערב"]}}}}}},"/instances/{id}/messages/list":{"post":{"operationId":"sendList","tags":["Messages"],"summary":"שליחת רשימת בחירה","description":"Interactive lists depend on the current WhatsApp client and server support. Acceptance does not guarantee display or delivery.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"title":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","minLength":1,"maxLength":1000},"footerText":{"type":"string","minLength":1,"maxLength":100},"buttonText":{"type":"string","minLength":1,"maxLength":40},"sections":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","minLength":1,"maxLength":100},"rows":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","minLength":1,"maxLength":200},"rowId":{"type":"string","minLength":1,"maxLength":100}},"required":["title","rowId"]},"minItems":1,"maxItems":10}},"required":["title","rows"]},"minItems":1,"maxItems":10}},"required":["number","title","buttonText","sections"]},"example":{"number":"972501234567","title":"איך אפשר לעזור?","buttonText":"בחירת נושא","sections":[{"title":"שירות","rows":[{"title":"תמיכה","rowId":"support"}]}]}}}}}},"/instances/{id}/messages/buttons":{"post":{"operationId":"sendButtons","tags":["Messages"],"summary":"שליחת כפתורי תשובה","description":"Reply buttons depend on the current WhatsApp client and server support. Acceptance does not guarantee display or delivery.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","messages:advanced"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"remoteJid":{"type":"string"},"fromMe":{"type":"boolean"}}},"status":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"key":{"id":"EXAMPLE_MESSAGE_ID","remoteJid":"972501234567@s.whatsapp.net","fromMe":true},"status":"PENDING"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"title":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","minLength":1,"maxLength":1000},"footer":{"type":"string","minLength":1,"maxLength":100},"buttons":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["reply"]},"displayText":{"type":"string","minLength":1,"maxLength":40},"id":{"type":"string","minLength":1,"maxLength":100}},"required":["type","displayText","id"]},"minItems":1,"maxItems":3}},"required":["number","title","buttons"]},"example":{"number":"972501234567","title":"להמשיך?","buttons":[{"type":"reply","displayText":"כן","id":"yes"}]}}}}}},"/instances/{id}/contacts/search":{"post":{"operationId":"findContacts","tags":["Chats"],"summary":"חיפוש אנשי קשר","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","properties":{"remoteJid":{"type":"string"},"pushName":{"type":"string"}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[{"remoteJid":"972501234567@s.whatsapp.net","pushName":"לקוח לדוגמה"}]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"limit":{"type":"integer","minimum":1,"maximum":100},"remoteJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"},"pushName":{"type":"string","minLength":1,"maxLength":100}},"required":[]},"example":{"page":1,"limit":25}}}}}},"/instances/{id}/chats/search":{"post":{"operationId":"findChats","tags":["Chats"],"summary":"חיפוש שיחות","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","properties":{"remoteJid":{"type":"string"},"unreadMessages":{"type":"number"}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[{"remoteJid":"972501234567@s.whatsapp.net","unreadMessages":2}]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"limit":{"type":"integer","minimum":1,"maximum":100},"remoteJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"}},"required":[]},"example":{"page":1,"limit":25}}}}}},"/instances/{id}/messages/search":{"post":{"operationId":"findMessages","tags":["Chats"],"summary":"חיפוש הודעות","description":"Searches stored messages for this connection only. Availability depends on message history saved by the server. Each page contains at most 100 records.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"messages":{"type":"object","properties":{"total":{"type":"number"},"pages":{"type":"number"},"currentPage":{"type":"number"},"records":{"type":"array","items":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"fromMe":{"type":"boolean"},"remoteJid":{"type":"string"}}},"message":{"type":"object","properties":{"conversation":{"type":"string"}}},"messageType":{"type":"string"}}}}}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"messages":{"total":1,"pages":1,"currentPage":1,"records":[{"key":{"id":"EXAMPLE_MESSAGE_ID","fromMe":false,"remoteJid":"972501234567@s.whatsapp.net"},"message":{"conversation":"שלום"},"messageType":"conversation"}]}}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"limit":{"type":"integer","minimum":1,"maximum":100},"remoteJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"},"message_id":{"type":"string","minLength":1,"maxLength":250}},"required":[]},"example":{"page":1,"limit":25,"remoteJid":"972501234567@s.whatsapp.net"}}}}}},"/instances/{id}/contacts/check":{"post":{"operationId":"checkNumbers","tags":["Chats"],"summary":"בדיקת מספרי WhatsApp","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","properties":{"exists":{"type":"boolean"},"jid":{"type":"string"},"number":{"type":"string"}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[{"exists":true,"jid":"972501234567@s.whatsapp.net","number":"972501234567"}]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"numbers":{"type":"array","items":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"minItems":1,"maxItems":50}},"required":["numbers"]},"example":{"numbers":["972501234567"]}}}}}},"/instances/{id}/messages/read":{"post":{"operationId":"markMessagesRead","tags":["Chats"],"summary":"סימון הודעות כנקראו","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","chats:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"readMessages":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","minLength":1,"maxLength":250},"fromMe":{"type":"boolean"},"remoteJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"},"participant":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"}},"required":["id","fromMe","remoteJid"]},"minItems":1,"maxItems":50}},"required":["readMessages"]},"example":{"readMessages":[{"id":"EXAMPLE_MESSAGE_ID","fromMe":false,"remoteJid":"972501234567@s.whatsapp.net"}]}}}}}},"/instances/{id}/chats/archive":{"post":{"operationId":"archiveChat","tags":["Chats"],"summary":"ארכוב שיחה או ביטול ארכוב","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","chats:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"chat":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"},"archive":{"type":"boolean"}},"required":["chat","archive"]},"example":{"chat":"972501234567@s.whatsapp.net","archive":true}}}}}},"/instances/{id}/chats/unread":{"post":{"operationId":"markChatUnread","tags":["Chats"],"summary":"סימון שיחה כלא נקראה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","chats:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"chat":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@(s\\.whatsapp\\.net|g\\.us|lid)$","example":"972501234567@s.whatsapp.net"}},"required":["chat"]},"example":{"chat":"972501234567@s.whatsapp.net"}}}}}},"/instances/{id}/chats/presence":{"post":{"operationId":"chatPresence","tags":["Chats"],"summary":"חיווי הקלדה בשיחה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","chats:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(?:[1-9][0-9]{7,14}|[0-9]+(?:-[0-9]+)?@g\\.us)$","example":"972501234567"},"presence":{"type":"string","enum":["composing","recording","paused","available","unavailable"]},"delay":{"type":"integer","minimum":0,"maximum":5000}},"required":["number","presence","delay"]},"example":{"number":"972501234567","presence":"composing","delay":1000}}}}}},"/instances/{id}/contacts/block":{"post":{"operationId":"blockContact","tags":["Chats"],"summary":"חסימה או ביטול חסימה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","chats:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"status":{"type":"string","enum":["block","unblock"]}},"required":["number","status"]},"example":{"number":"972501234567","status":"block"}}}}}},"/instances/{id}/profile/name":{"post":{"operationId":"updateProfileName","tags":["Profile"],"summary":"עדכון שם הפרופיל","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","settings:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":100}},"required":["name"]},"example":{"name":"צוות השירות"}}}}}},"/instances/{id}/profile/status":{"post":{"operationId":"updateProfileStatus","tags":["Profile"],"summary":"עדכון תיאור הפרופיל","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","settings:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","minLength":1,"maxLength":139}},"required":["status"]},"example":{"status":"כאן לעזור"}}}}}},"/instances/{id}/profile/picture":{"post":{"operationId":"updateProfilePicture","tags":["Profile"],"summary":"עדכון תמונת הפרופיל","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","settings:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"picture":{"type":"string","minLength":1,"maxLength":6990508,"format":"base64","description":"Raw Base64, up to 5 MiB decoded. URLs and data: prefixes are not accepted.","example":"JVBERi0xLjQK"}},"required":["picture"]},"example":{"picture":"iVBORw0KGgo="}}}}},"delete":{"operationId":"removeProfilePicture","tags":["Profile"],"summary":"הסרת תמונת פרופיל","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","settings:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{},"required":[]},"example":{}}}}}},"/instances/{id}/profile/find":{"post":{"operationId":"getProfile","tags":["Profile"],"summary":"פרופיל של מספר","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"name":{"type":"string"},"number":{"type":"string"}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"name":"צוות השירות","number":"972501234567"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"}},"required":["number"]},"example":{"number":"972501234567"}}}}}},"/instances/{id}/profile/picture/find":{"post":{"operationId":"getProfilePicture","tags":["Profile"],"summary":"כתובת תמונת פרופיל","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"profilePictureUrl":{"type":"string"}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"profilePictureUrl":"https://example.com/profile.jpg"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"}},"required":["number"]},"example":{"number":"972501234567"}}}}}},"/instances/{id}/groups":{"post":{"operationId":"createGroup","tags":["Groups"],"summary":"יצירת קבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"id":"120363000000000000@g.us","subject":"צוות העבודה"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"subject":{"type":"string","minLength":1,"maxLength":100},"participants":{"type":"array","items":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"minItems":1,"maxItems":100},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["subject","participants"]},"example":{"subject":"צוות העבודה","participants":["972501234567"]}}}}},"get":{"operationId":"listGroups","tags":["Groups"],"summary":"רשימת הקבוצות","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","groups:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string"}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[{"id":"120363000000000000@g.us","subject":"צוות העבודה"}]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}},"delete":{"operationId":"leaveGroup","tags":["Groups"],"summary":"יציאה מקבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"}},"required":["groupJid"]},"example":{"groupJid":"120363000000000000@g.us"}}}}}},"/instances/{id}/groups/info":{"get":{"operationId":"getGroup","tags":["Groups"],"summary":"מידע על קבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"groupJid","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"example":"120363000000000000@g.us"}],"x-required-scopes":["instances:read","groups:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string"}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"id":"120363000000000000@g.us","subject":"צוות העבודה"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}}},"/instances/{id}/groups/participants":{"get":{"operationId":"getGroupParticipants","tags":["Groups"],"summary":"משתתפי הקבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"groupJid","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"example":"120363000000000000@g.us"}],"x-required-scopes":["instances:read","groups:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"admin":{"type":"string"}}}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"participants":[{"id":"972501234567@s.whatsapp.net","admin":"admin"}]}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}},"post":{"operationId":"updateParticipants","tags":["Groups"],"summary":"הוספה, הסרה והרשאות משתתפים","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"action":{"type":"string","enum":["add","remove","promote","demote"]},"participants":{"type":"array","items":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"minItems":1,"maxItems":100}},"required":["groupJid","action","participants"]},"example":{"groupJid":"120363000000000000@g.us","action":"add","participants":["972501234567"]}}}}}},"/instances/{id}/groups/invite":{"get":{"operationId":"getGroupInvite","tags":["Groups"],"summary":"קישור הזמנה לקבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"groupJid","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"example":"120363000000000000@g.us"}],"x-required-scopes":["instances:read","groups:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"inviteUrl":{"type":"string"}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"inviteUrl":"https://chat.whatsapp.com/EXAMPLE"}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}}},"/instances/{id}/groups/subject":{"post":{"operationId":"updateGroupSubject","tags":["Groups"],"summary":"שינוי שם קבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"subject":{"type":"string","minLength":1,"maxLength":100}},"required":["groupJid","subject"]},"example":{"groupJid":"120363000000000000@g.us","subject":"שם הקבוצה החדש"}}}}}},"/instances/{id}/groups/description":{"post":{"operationId":"updateGroupDescription","tags":["Groups"],"summary":"שינוי תיאור קבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"description":{"type":"string","minLength":0,"maxLength":1000}},"required":["groupJid","description"]},"example":{"groupJid":"120363000000000000@g.us","description":"עדכונים לצוות"}}}}}},"/instances/{id}/groups/settings":{"post":{"operationId":"updateGroupSettings","tags":["Groups"],"summary":"הרשאות פרסום ועריכה בקבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"action":{"type":"string","enum":["announcement","not_announcement","unlocked","locked"]}},"required":["groupJid","action"]},"example":{"groupJid":"120363000000000000@g.us","action":"announcement"}}}}}},"/instances/{id}/groups/ephemeral":{"post":{"operationId":"updateGroupEphemeral","tags":["Groups"],"summary":"הודעות נעלמות בקבוצה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"},"expiration":{"type":"integer","enum":[0,86400,604800,7776000]}},"required":["groupJid","expiration"]},"example":{"groupJid":"120363000000000000@g.us","expiration":604800}}}}}},"/instances/{id}/groups/invite/revoke":{"post":{"operationId":"revokeGroupInvite","tags":["Groups"],"summary":"ביטול קישור הזמנה","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","groups:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"groupJid":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[0-9]+(?:-[0-9]+)?@g\\.us$","example":"120363000000000000@g.us"}},"required":["groupJid"]},"example":{"groupJid":"120363000000000000@g.us"}}}}}},"/instances/{id}/settings":{"get":{"operationId":"getSettings","tags":["Settings"],"summary":"קריאת הגדרות חיבור","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","settings:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"object","properties":{"rejectCall":{"type":"boolean"},"msgCall":{"type":"string"},"groupsIgnore":{"type":"boolean"},"alwaysOnline":{"type":"boolean"},"readMessages":{"type":"boolean"},"readStatus":{"type":"boolean"},"syncFullHistory":{"type":"boolean"}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":{"rejectCall":false,"msgCall":"","groupsIgnore":false,"alwaysOnline":false,"readMessages":false,"readStatus":false,"syncFullHistory":false}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}},"post":{"operationId":"setSettings","tags":["Settings"],"summary":"שמירת הגדרות חיבור","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","settings:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rejectCall":{"type":"boolean"},"msgCall":{"type":"string","minLength":0,"maxLength":500},"groupsIgnore":{"type":"boolean"},"alwaysOnline":{"type":"boolean"},"readMessages":{"type":"boolean"},"readStatus":{"type":"boolean"},"syncFullHistory":{"type":"boolean"}},"required":["rejectCall","msgCall","groupsIgnore","alwaysOnline","readMessages","readStatus","syncFullHistory"]},"example":{"rejectCall":false,"msgCall":"","groupsIgnore":false,"alwaysOnline":false,"readMessages":false,"readStatus":false,"syncFullHistory":false}}}}}},"/instances/{id}/labels":{"get":{"operationId":"getLabels","tags":["Labels"],"summary":"רשימת תוויות","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"number"}}}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[{"id":"1","name":"לקוחות","color":1}]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}},"post":{"operationId":"handleLabel","tags":["Labels"],"summary":"שיוך או הסרת תווית","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one action. Reuse for retries with identical input. Pending or uncertain actions must be reviewed before starting a new event.","schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[A-Za-z0-9_.:-]+$"},"example":"event-2026-001"}],"x-required-scopes":["instances:read","chats:write"],"x-mutating":true,"responses":{"200":{"description":"The server accepted the operation; not proof of message delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","uncertain"]},"error":{"type":"string"},"message":{"type":"string"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"uncertain","message":"יש לבדוק את תוצאת הפעולה לפני בקשה חדשה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"labelId":{"type":"string","minLength":1,"maxLength":100},"action":{"type":"string","enum":["add","remove"]}},"required":["number","labelId","action"]},"example":{"number":"972501234567","labelId":"1","action":"add"}}}}}},"/instances/{id}/business/catalog":{"post":{"operationId":"getCatalog","tags":["Business"],"summary":"קטלוג עסקי","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object"}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"limit":{"type":"integer","minimum":1,"maximum":100}},"required":["number"]},"example":{"number":"972501234567","limit":25}}}}}},"/instances/{id}/business/collections":{"post":{"operationId":"getCollections","tags":["Business"],"summary":"אוספים בקטלוג","description":"הפעולה מתבצעת בחיבור שנבחר בלבד, בכפוף להרשאות המפתח והחשבון.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"integer","minimum":1},"example":1}],"x-required-scopes":["instances:read","chats:read"],"x-mutating":false,"responses":{"200":{"description":"Data for the authorized connection.","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"data":{"type":"array","items":{"type":"object"}}}},"example":{"instance":{"id":1,"name":"שירות לקוחות"},"data":[]}}}},"400":{"description":"Invalid parameters or unsupported fields.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"401":{"description":"Missing, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"402":{"description":"The paid service period has ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Missing scope or current user permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Resource absent or not permitted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"409":{"description":"Quota exhausted, busy, pending/uncertain result, or reused event ID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"413":{"description":"Request body exceeds 8 MiB. Media is limited to 5 MiB decoded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"415":{"description":"Expected application/json.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"422":{"description":"Upstream rejected the operation. Retrying the same event will not execute it again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"60 requests per minute per key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"502":{"description":"No valid result could be retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"503":{"description":"Connection server unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","minLength":1,"maxLength":15,"pattern":"^[1-9][0-9]{7,14}$","example":"972501234567"},"limit":{"type":"integer","minimum":1,"maximum":100}},"required":["number"]},"example":{"number":"972501234567","limit":25}}}}}},"/operations/{id}":{"get":{"operationId":"getOperation","tags":["Requests"],"summary":"תוצאת פעולה מתקדמת","description":"Only the exact key that created the operation can read it. The original scope and current connection permissions are required. Data is unavailable after removal or reassignment of the connection. accepted is not proof of message delivery.","parameters":[{"name":"id","in":"path","required":true,"description":"Portal connection ID returned by GET /instances. Not an upstream name.","schema":{"type":"string","format":"uuid"},"example":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7"}],"x-required-scopes":["הרשאת הפעולה המקורית"],"responses":{"200":{"description":"Operation receipt","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","failed","uncertain"]},"data":{"type":"object"}}},"example":{"request_id":"6cc469ec-0b16-443a-8b4c-6b3ea7c00bf7","status":"accepted","data":{"success":true}}}}},"401":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"403":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"404":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}},"429":{"description":"Request rejected","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"הבקשה לא הושלמה."}}}}}}}},"tags":[{"name":"Connections","description":"חיבורים"},{"name":"Messages","description":"שליחת הודעות"},{"name":"Chats","description":"שיחות ואנשי קשר"},{"name":"Groups","description":"קבוצות"},{"name":"Profile","description":"פרופיל"},{"name":"Settings","description":"הגדרות"},{"name":"Labels","description":"תוויות"},{"name":"Business","description":"WhatsApp Business"},{"name":"Requests","description":"מעקב בקשות"}],"x-availability":[{"title":"עריכה ומחיקה של הודעות","description":"אינן זמינות דרך הפורטל בגרסה זו. נדרש תיקון הפרדה במסד הנתונים של שרת החיבורים לפני הפעלתן."},{"title":"תבניות רשמיות, Proxy ו-Webhooks","description":"תבניות רשמיות שייכות למסלול WhatsApp Cloud. הגדרות תשתית ויעדי Webhook מנוהלות בנפרד ואינן פתוחות דרך מפתח לקוח. אפשר לקרוא הודעות שמורות באמצעות חיפוש הודעות."},{"title":"מדיה וכפתורים","description":"העלאת קבצים באמצעות Base64 עד 5 MiB. תמיכה בכפתורים וברשימות תלויה גם בגרסת WhatsApp. תוצאה accepted מאשרת קבלת בקשה ואינה אישור מסירה."}]}