**גרסאות API** · **V2 (Latest)** · [V1](/integrations/v1/docs?lang=he)

# Transactional Reminders

OpenAPI 3.0.3 · API 2.0.0

```json
[
  {
    "url": "https://api.unisoft.world/integrations/v2",
    "description": "API"
  }
]
```

## פעולות

## POST /transactional-reminders/preview

Preview one native reminder email for a configured recipient

`preview_one_off_reminder`

Requires transactional_reminders:read AND contacts:read; sending additionally requires the independent opt-in transactional_reminders:send. messages:send and contacts:write do not replace these grants. Resolve an existing rule with list/get_transactional_reminder_rules and select one recipientContactId returned in its native recipientContactIds; configured children can route to parents. This EMAIL-only one-off flow does not choose arbitrary unrelated contacts, create a rule, change recurring settings or implement a new religious calendar. Derived CONTACT HAZKARA recap rows have no recipient path here. An explicitly requested one-off can target an admitted recipient even when the automatic rule recipient path is disabled; this does not enable the background rule. All subject, configured-recipient, parent and recap relations are readmitted independently in the organisation; campaign-restricted keys are refused. The subject, body, HTML and recipient language reuse the native reminder builder and current sender selection. The HTML is preview content, not trusted executable UI: use a sandbox if displaying it. No private recipient address/phone, SMTP configuration, session or provider response is returned. Template copy can naturally contain the organisation contact signature used in the actual reminder. nextDate and calendarTimeZone identify the native server-local anniversary calculation, not a send schedule or the organisation display timezone. The commemoration window reuses native Hebcal TSET calculations; missing dates/channels/senders return 409, never a fabricated date or a new recipient. emailConfig=null means native fallback selection at transport time, not a promise of a specific sender. A preview does not verify SMTP credentials, consent or deliverability. This POST is a pure read/preview: no send, journal, queue insertion, provider call or persistent calendar initialization occurs. Return previewRevision with the shown native content; a later send must supply that revision unchanged. Send-specific variables such as {{mailing_unsubscribe}} can remain literal in the preview and are rendered once against the actual deterministic send id only when enqueueing.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:read",
  "additional": [
    "contacts:read"
  ]
}
```

### גוף הבקשה

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "BIRTHDAY",
              "HAZKARA"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "CONTACT",
              "CONTACT_RECIPIENT",
              "LEGACY"
            ]
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "recipientContactId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "type",
          "source",
          "id",
          "recipientContactId"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Pure native reminder preview; no journal or queue is written.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderPreviewResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_REMINDER_DELIVERY or invalid rule type/source/id.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "REMINDER_RECIPIENT_NOT_CONFIGURED, REMINDER_CHANNEL_UNAVAILABLE, REMINDER_SENDER_UNAVAILABLE, REMINDER_CALENDAR_UNAVAILABLE, REMINDER_PREVIEW_CHANGED, IDEMPOTENCY_CONFLICT or unavailable stored rule/reference/history. Do not bypass the selected recipient or retry an uncertain send.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_DELIVERY_UNAVAILABLE. A transport error is not evidence that an enqueue failed.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:read",
  "x-unisoft-additional-scopes": [
    "contacts:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /transactional-reminders/send

Queue an explicitly requested one-off reminder email

`send_one_off_reminder`

Requires transactional_reminders:read AND contacts:read; sending additionally requires the independent opt-in transactional_reminders:send. messages:send and contacts:write do not replace these grants. Resolve an existing rule with list/get_transactional_reminder_rules and select one recipientContactId returned in its native recipientContactIds; configured children can route to parents. This EMAIL-only one-off flow does not choose arbitrary unrelated contacts, create a rule, change recurring settings or implement a new religious calendar. Derived CONTACT HAZKARA recap rows have no recipient path here. An explicitly requested one-off can target an admitted recipient even when the automatic rule recipient path is disabled; this does not enable the background rule. All subject, configured-recipient, parent and recap relations are readmitted independently in the organisation; campaign-restricted keys are refused. The subject, body, HTML and recipient language reuse the native reminder builder and current sender selection. The HTML is preview content, not trusted executable UI: use a sandbox if displaying it. No private recipient address/phone, SMTP configuration, session or provider response is returned. Template copy can naturally contain the organisation contact signature used in the actual reminder. nextDate and calendarTimeZone identify the native server-local anniversary calculation, not a send schedule or the organisation display timezone. The commemoration window reuses native Hebcal TSET calculations; missing dates/channels/senders return 409, never a fabricated date or a new recipient. emailConfig=null means native fallback selection at transport time, not a promise of a specific sender. A preview does not verify SMTP credentials, consent or deliverability. Obtain a fresh preview first and submit its exact previewRevision plus a new UUID idempotencyKey for this explicitly authorized recipient and message. Changed content, recipient evidence, language, rule or sender selection can invalidate the preview with REMINDER_PREVIEW_CHANGED before enqueue. A durable principal-and-organisation-bound command is inserted before the native send queue entry; the send id and queue identity are deterministic. Same key and identical request replay without enqueueing again; a different request with that key returns IDEMPOTENCY_CONFLICT. QUEUED means an insertion into the native EMAIL queue was acknowledged, not SMTP acceptance, delivery or reading. UNCERTAIN covers ambiguous enqueue acknowledgement or an interrupted command; it never authorizes an automatic retry or a new key. Replaying a PENDING/UNCERTAIN record remains UNCERTAIN and does not enqueue again. Read get_reminder_email_history using sendId for any subsequently recorded observations, but 404 does not prove that an uncertain send never happened. journalRecorded=false means final journal acknowledgement failed and the command returns UNCERTAIN. It never authorizes another enqueue. QUEUED requires an acknowledged deterministic queue insertion and final durable command journal, and still does not prove SMTP acceptance or delivery. This operation does not call SMTP/providers itself; the existing independent worker later processes the queue and can reject it under its own rules.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:send",
  "additional": [
    "transactional_reminders:read",
    "contacts:read"
  ]
}
```

### גוף הבקשה

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "BIRTHDAY",
              "HAZKARA"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "CONTACT",
              "CONTACT_RECIPIENT",
              "LEGACY"
            ]
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "recipientContactId": {
            "type": "string",
            "format": "uuid"
          },
          "previewRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "idempotencyKey": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "type",
          "source",
          "id",
          "recipientContactId",
          "previewRevision",
          "idempotencyKey"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Queue acknowledgement or explicitly unknown enqueue result; never delivered.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderSendResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_REMINDER_DELIVERY or invalid rule type/source/id.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "REMINDER_RECIPIENT_NOT_CONFIGURED, REMINDER_CHANNEL_UNAVAILABLE, REMINDER_SENDER_UNAVAILABLE, REMINDER_CALENDAR_UNAVAILABLE, REMINDER_PREVIEW_CHANGED, IDEMPOTENCY_CONFLICT or unavailable stored rule/reference/history. Do not bypass the selected recipient or retry an uncertain send.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_DELIVERY_UNAVAILABLE. A transport error is not evidence that an enqueue failed.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:send",
  "x-unisoft-additional-scopes": [
    "transactional_reminders:read",
    "contacts:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "action",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": true
  }
}
```

## GET /transactional-reminders/history

Read reminder email history and recorded delivery states

`list_reminder_email_history`

Requires BOTH transactional_reminders:read AND contacts:read; messages:* alone does not grant access. Read-only EMAIL history of birthday/hazkara reminders, including admitted historical annual sources. Personal/global custom reminders, SMS, WhatsApp and push are not covered by this native email-history slice; an empty response does not prove no reminder was sent on another channel. No send, enqueue, regeneration, retry, provider poll, SMTP call or calendar write occurs. Stored reminder.contactIds are independently admitted as exact current CRM references in this organisation; historical sources lacking metadata must resolve to admissible current contacts/legacy references or return 409. Missing/deleted/foreign/ambiguous relations refuse the projection rather than dropping private recipients. Campaign-restricted keys are refused because CRM membership cannot be independently established. nativeReminderId is the stored owner reference and can identify a contact/deceased person or legacy rule; it is not necessarily the external CONTACT_RECIPIENT rule UUID. type=null means the historical source does not establish birthday versus hazkara; never guess. INIT/QUEUED means queued, SUCCESS/ACCEPTED means the mail worker recorded SMTP acceptance, not final delivery or reading. ERROR can record a definitive failure or MAILER_DELIVERY_UNCERTAIN; neither grants retry permission. deliveryStatus is only the stored SMTP/DSN observation, null when unavailable; DELIVERED does not prove that a human read the email. Unknown states/dates remain null or UNKNOWN, never a fabricated timestamp. Dates are ISO instants. No recipient address, phone, raw provider/SMTP diagnostic, HTML, private source string or session is returned. The list is bounded to 2000 stored entries; exceeding it returns REMINDER_HISTORY_LIMIT_EXCEEDED without partial history. Limit/offset use recordedAt descending then id; reads are not a transaction snapshot. Authentication may update API-key usage telemetry.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:read",
  "additional": [
    "contacts:read"
  ]
}
```

### פרמטרים

```json
{
  "name": "contactId",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "limit",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 100,
    "default": 50
  }
}
```

```json
{
  "name": "offset",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 0,
    "maximum": 2000,
    "default": 0
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Stored email queue and delivery observations only.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderHistoryListResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid UUID/query/body.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_REMINDER_HISTORY, REMINDER_HISTORY_RELATION_UNAVAILABLE or REMINDER_HISTORY_LIMIT_EXCEEDED; no partial history or retry permission.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_HISTORY_UNAVAILABLE. No delivery was attempted.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:read",
  "x-unisoft-additional-scopes": [
    "contacts:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /transactional-reminders/history/{id}

Read one recorded reminder email state

`get_reminder_email_history`

Requires BOTH transactional_reminders:read AND contacts:read; messages:* alone does not grant access. Read-only EMAIL history of birthday/hazkara reminders, including admitted historical annual sources. Personal/global custom reminders, SMS, WhatsApp and push are not covered by this native email-history slice; an empty response does not prove no reminder was sent on another channel. No send, enqueue, regeneration, retry, provider poll, SMTP call or calendar write occurs. Stored reminder.contactIds are independently admitted as exact current CRM references in this organisation; historical sources lacking metadata must resolve to admissible current contacts/legacy references or return 409. Missing/deleted/foreign/ambiguous relations refuse the projection rather than dropping private recipients. Campaign-restricted keys are refused because CRM membership cannot be independently established. nativeReminderId is the stored owner reference and can identify a contact/deceased person or legacy rule; it is not necessarily the external CONTACT_RECIPIENT rule UUID. type=null means the historical source does not establish birthday versus hazkara; never guess. INIT/QUEUED means queued, SUCCESS/ACCEPTED means the mail worker recorded SMTP acceptance, not final delivery or reading. ERROR can record a definitive failure or MAILER_DELIVERY_UNCERTAIN; neither grants retry permission. deliveryStatus is only the stored SMTP/DSN observation, null when unavailable; DELIVERED does not prove that a human read the email. Unknown states/dates remain null or UNKNOWN, never a fabricated timestamp. Dates are ISO instants. No recipient address, phone, raw provider/SMTP diagnostic, HTML, private source string or session is returned. The list is bounded to 2000 stored entries; exceeding it returns REMINDER_HISTORY_LIMIT_EXCEEDED without partial history. Limit/offset use recordedAt descending then id; reads are not a transaction snapshot. Authentication may update API-key usage telemetry.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:read",
  "additional": [
    "contacts:read"
  ]
}
```

### פרמטרים

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Stored email queue and delivery observations only.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderHistoryResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid UUID/query/body.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_REMINDER_HISTORY, REMINDER_HISTORY_RELATION_UNAVAILABLE or REMINDER_HISTORY_LIMIT_EXCEEDED; no partial history or retry permission.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_HISTORY_UNAVAILABLE. No delivery was attempted.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:read",
  "x-unisoft-additional-scopes": [
    "contacts:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /transactional-reminders/rules

Read birthday and hazkara rules and next dates

`list_transactional_reminder_rules`

Requires BOTH transactional_reminders:read AND contacts:read. Reads existing birthday and hazkara (Hebrew death-anniversary) rules without sending, enqueueing, retrying, regenerating reminders, initializing a calendar, calling a provider or changing CRM data. BIRTHDAY follows the native ANNIV owner; HAZKARA follows the native deceased-contact or legacy owner. source CONTACT with BIRTHDAY uses the contact id; CONTACT with HAZKARA uses the deceased contact id and is the responsible-only recap, not a recipient rule. CONTACT_RECIPIENT is one existing contact.rappels recipient rule: its id differs from subjectContactId, and notifyRecipient is always true under the native worker; no silence toggle is invented. LEGACY uses the stored reminder id; a legacy birthday shadowed by a birth-dated contact is absent. recipientContactIds are admitted CRM references, never phone numbers or email addresses. configuredRecipientContactId identifies the directly configured CRM contact; recipientContactIds follow the native routing to admitted non-deceased parents when that contact has parents, for birthday and hazkara rules alike. notifyRecipient=false suppresses recipient notifications, not the organisation responsible recap. A null notifyRecipient means not applicable. This is configuration, not consent, channel availability, delivery state or a promise that any message will be sent. customText is stored text; a responsible-only birthday can retain inactive customText. Hebrew dates and the next anniversary use the existing reminder/Hebcal owner including its historic sunset/noon and short-month conventions, not a new religious-calendar policy. nextDate is a civil YYYY-MM-DD, not a send instant; timeZone is the actual server-local calculation timezone, explicitly not an inferred organisation timezone. calendarStatus=UNAVAILABLE returns null nextDate/nextHebrewDate; never substitute a date or timezone. Unknown/malformed historical data is refused with 409 instead of coerced or silently granting access. All related contacts are independently admitted in the current organisation; missing, deleted, foreign or ambiguous relations refuse the projection. Keys restricted to campaigns are refused with CAMPAIGN_RESTRICTED_KEY because this CRM domain has no independent campaign-membership owner. At most 5000 contacts and 2000 effective/raw rules are admitted; exceeding the bound returns REMINDER_READ_LIMIT_EXCEEDED without a partial result. revision is an opaque snapshot hash, not an integer or a transaction lock. management=SUPPORTED and mutableFields describe settings this facade can update with independently granted write scopes; management=DERIVED_RULE means the native responsible recap has no independent editable setting. It does not expose creation, deletion, CRM date editing, organisation frequency/sender configuration, history or a one-off send. Use separate live tools for independently available domains; messages:* alone never grants reminder or contact access. Authentication may update API-key usage telemetry.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:read",
  "additional": [
    "contacts:read"
  ]
}
```

### פרמטרים

```json
{
  "name": "type",
  "in": "query",
  "description": "Optional rule type; birthdays and hazkarot use the Hebrew anniversary owner.",
  "schema": {
    "type": "string",
    "enum": [
      "BIRTHDAY",
      "HAZKARA"
    ]
  }
}
```

```json
{
  "name": "contactId",
  "in": "query",
  "description": "Optional CRM subject or recipient contact UUID. Does not search private contact coordinates.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "limit",
  "in": "query",
  "description": "Maximum returned rules, after filtering.",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 100,
    "default": 50
  }
}
```

```json
{
  "name": "offset",
  "in": "query",
  "description": "Offset in the filtered type/source/id order. This is not a transaction snapshot.",
  "schema": {
    "type": "integer",
    "minimum": 0,
    "maximum": 2000,
    "default": 0
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Allowlisted reminder rules and native next-anniversary observations.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TransactionalReminderListResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid type, source, UUID, query parameter or unexpected request body.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY; no reminder or contact data is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: the requested effective rule is absent or outside the current organisation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_REMINDER_HISTORY, REMINDER_RELATION_UNAVAILABLE, REMINDER_ORGANISATION_UNAVAILABLE, REMINDER_CALENDAR_UNAVAILABLE or REMINDER_READ_LIMIT_EXCEEDED. Review stored data in its owning application; no send or retry is authorized.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_READ_UNAVAILABLE. No reminder delivery was attempted.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:read",
  "x-unisoft-additional-scopes": [
    "contacts:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /transactional-reminders/rules/{type}/{source}/{id}

Read one existing birthday or hazkara rule

`get_transactional_reminder_rule`

Requires BOTH transactional_reminders:read AND contacts:read. Reads existing birthday and hazkara (Hebrew death-anniversary) rules without sending, enqueueing, retrying, regenerating reminders, initializing a calendar, calling a provider or changing CRM data. BIRTHDAY follows the native ANNIV owner; HAZKARA follows the native deceased-contact or legacy owner. source CONTACT with BIRTHDAY uses the contact id; CONTACT with HAZKARA uses the deceased contact id and is the responsible-only recap, not a recipient rule. CONTACT_RECIPIENT is one existing contact.rappels recipient rule: its id differs from subjectContactId, and notifyRecipient is always true under the native worker; no silence toggle is invented. LEGACY uses the stored reminder id; a legacy birthday shadowed by a birth-dated contact is absent. recipientContactIds are admitted CRM references, never phone numbers or email addresses. configuredRecipientContactId identifies the directly configured CRM contact; recipientContactIds follow the native routing to admitted non-deceased parents when that contact has parents, for birthday and hazkara rules alike. notifyRecipient=false suppresses recipient notifications, not the organisation responsible recap. A null notifyRecipient means not applicable. This is configuration, not consent, channel availability, delivery state or a promise that any message will be sent. customText is stored text; a responsible-only birthday can retain inactive customText. Hebrew dates and the next anniversary use the existing reminder/Hebcal owner including its historic sunset/noon and short-month conventions, not a new religious-calendar policy. nextDate is a civil YYYY-MM-DD, not a send instant; timeZone is the actual server-local calculation timezone, explicitly not an inferred organisation timezone. calendarStatus=UNAVAILABLE returns null nextDate/nextHebrewDate; never substitute a date or timezone. Unknown/malformed historical data is refused with 409 instead of coerced or silently granting access. All related contacts are independently admitted in the current organisation; missing, deleted, foreign or ambiguous relations refuse the projection. Keys restricted to campaigns are refused with CAMPAIGN_RESTRICTED_KEY because this CRM domain has no independent campaign-membership owner. At most 5000 contacts and 2000 effective/raw rules are admitted; exceeding the bound returns REMINDER_READ_LIMIT_EXCEEDED without a partial result. revision is an opaque snapshot hash, not an integer or a transaction lock. management=SUPPORTED and mutableFields describe settings this facade can update with independently granted write scopes; management=DERIVED_RULE means the native responsible recap has no independent editable setting. It does not expose creation, deletion, CRM date editing, organisation frequency/sender configuration, history or a one-off send. Use separate live tools for independently available domains; messages:* alone never grants reminder or contact access. Authentication may update API-key usage telemetry.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:read",
  "additional": [
    "contacts:read"
  ]
}
```

### פרמטרים

```json
{
  "name": "type",
  "in": "path",
  "required": true,
  "description": "Exact type returned by list_transactional_reminder_rules.",
  "schema": {
    "type": "string",
    "enum": [
      "BIRTHDAY",
      "HAZKARA"
    ]
  }
}
```

```json
{
  "name": "source",
  "in": "path",
  "required": true,
  "description": "Exact source returned by the list; CONTACT_RECIPIENT is valid only with HAZKARA.",
  "schema": {
    "type": "string",
    "enum": [
      "CONTACT",
      "CONTACT_RECIPIENT",
      "LEGACY"
    ]
  }
}
```

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Rule UUID returned by the list; a CONTACT_RECIPIENT id is not the deceased subject id.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Allowlisted reminder rules and native next-anniversary observations.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TransactionalReminderRuleResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid type, source, UUID, query parameter or unexpected request body.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY; no reminder or contact data is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: the requested effective rule is absent or outside the current organisation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_REMINDER_HISTORY, REMINDER_RELATION_UNAVAILABLE, REMINDER_ORGANISATION_UNAVAILABLE, REMINDER_CALENDAR_UNAVAILABLE or REMINDER_READ_LIMIT_EXCEEDED. Review stored data in its owning application; no send or retry is authorized.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_READ_UNAVAILABLE. No reminder delivery was attempted.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:read",
  "x-unisoft-additional-scopes": [
    "contacts:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## PATCH /transactional-reminders/rules/{type}/{source}/{id}

Update supported settings of an existing birthday or hazkara rule

`update_transactional_reminder_rule`

Requires ALL of transactional_reminders:write, transactional_reminders:read, contacts:read and contacts:write. Update only the settings named in mutableFields returned by a fresh rule read. CONTACT BIRTHDAY and LEGACY rules support notifyRecipient and customText. CONTACT_RECIPIENT HAZKARA supports customText only; its native worker always addresses its existing recipient and ignores silence. CONTACT HAZKARA is a derived responsible recap and cannot be independently toggled or edited. This adapter changes exactly the existing native rappelAnniv, rappels[].text or legacy silence/text settings with compare-and-set; it does not create or delete a rule, change a CRM birth/death date, choose a new recipient, configure organisation frequency/sender, send, enqueue, regenerate, retry a delivery or call a provider. notifyRecipient=false suppresses the recipient path only; it never disables the responsible recap. customText remains stored even when recipient notification is disabled. Enabling a rule can allow a future independent native worker run to deliver reminders: it is a persistent setting change, not a one-off send. First resolve type/source/id with list/get; pass its opaque 64-character revision as expectedRevision and a new UUID idempotencyKey for the explicitly requested change. Unknown keys, wrong types and unsupported fields are refused. All subject, recipient, parent and recap contact references are readmitted in the authenticated organisation; campaign-restricted keys are refused. A revision mismatch returns 409 before mutation, or status REFUSED with REMINDER_REVISION_CHANGED if it loses the compare-and-set race. Read current configuration and obtain a new user-requested change before submitting a changed command. The same key and identical payload replays its principal-and-organisation-bound command without running the mutation again; changed payload with that key returns IDEMPOTENCY_CONFLICT. success=true is the command envelope, not necessarily an applied setting: inspect status. SUCCEEDED confirms the native settings write; PENDING or UNCERTAIN never permits retry with a new key or automatic execution. Re-read the rule and replay the identical key to inspect the saved command; the replay may remain PENDING if recording was interrupted. journalRecorded=false means final durable journal acknowledgement is unavailable: the command returns UNCERTAIN and never permits automatic replay, while a later replay can remain PENDING. Never infer email consent, contactability, delivery, a send instant or a new religious-calendar policy from this change. Read scope contracts describe native date and timezone limitations.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "transactional_reminders:write",
  "additional": [
    "transactional_reminders:read",
    "contacts:read",
    "contacts:write"
  ]
}
```

### פרמטרים

```json
{
  "name": "type",
  "in": "path",
  "required": true,
  "description": "Exact type returned by list_transactional_reminder_rules.",
  "schema": {
    "type": "string",
    "enum": [
      "BIRTHDAY",
      "HAZKARA"
    ]
  }
}
```

```json
{
  "name": "source",
  "in": "path",
  "required": true,
  "description": "Exact source returned by the list; CONTACT_RECIPIENT is valid only with HAZKARA.",
  "schema": {
    "type": "string",
    "enum": [
      "CONTACT",
      "CONTACT_RECIPIENT",
      "LEGACY"
    ]
  }
}
```

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Rule UUID returned by the list; a CONTACT_RECIPIENT id is not the deceased subject id.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### גוף הבקשה

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "idempotencyKey": {
            "type": "string",
            "format": "uuid"
          },
          "patch": {
            "type": "object",
            "minProperties": 1,
            "properties": {
              "notifyRecipient": {
                "type": "boolean"
              },
              "customText": {
                "type": "string",
                "maxLength": 10000
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "expectedRevision",
          "idempotencyKey",
          "patch"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Allowlisted reminder rules and native next-anniversary observations.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TransactionalReminderChangeResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid type, source, UUID, query parameter or unexpected request body.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or CAMPAIGN_RESTRICTED_KEY; no reminder or contact data is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: the requested effective rule is absent or outside the current organisation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "REMINDER_REVISION_CHANGED, REMINDER_SETTING_UNSUPPORTED, IDEMPOTENCY_CONFLICT, INVALID_REMINDER_COMMAND_HISTORY or an unavailable stored rule/reference/calendar. No unsupported setting is changed; inspect the current rule before making another requested change.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "REMINDER_READ_UNAVAILABLE. No reminder delivery was attempted.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "transactional_reminders:write",
  "x-unisoft-additional-scopes": [
    "transactional_reminders:read",
    "contacts:read",
    "contacts:write"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "update",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## סכמות

```json
{
  "components": {
    "schemas": {
      "ReminderPreviewResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "type",
              "source",
              "id",
              "recipientContactId",
              "channel",
              "ruleRevision",
              "previewRevision",
              "subject",
              "message",
              "html",
              "language",
              "nextDate",
              "calendarTimeZone",
              "emailConfig",
              "senderSelection"
            ],
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "BIRTHDAY",
                  "HAZKARA"
                ]
              },
              "source": {
                "type": "string",
                "enum": [
                  "CONTACT",
                  "CONTACT_RECIPIENT",
                  "LEGACY"
                ]
              },
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "recipientContactId": {
                "type": "string",
                "format": "uuid"
              },
              "channel": {
                "type": "string",
                "enum": [
                  "EMAIL"
                ]
              },
              "ruleRevision": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "previewRevision": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "subject": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "html": {
                "type": "string"
              },
              "language": {
                "type": "string"
              },
              "nextDate": {
                "type": "string",
                "format": "date"
              },
              "calendarTimeZone": {
                "type": "string"
              },
              "emailConfig": {
                "type": "string",
                "nullable": true
              },
              "senderSelection": {
                "type": "string",
                "enum": [
                  "EXPLICIT",
                  "NATIVE_FALLBACK"
                ]
              }
            }
          }
        }
      },
      "ReminderSendResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "requestId",
              "sendId",
              "status",
              "replayed",
              "journalRecorded"
            ],
            "properties": {
              "requestId": {
                "type": "string",
                "format": "uuid"
              },
              "sendId": {
                "type": "string",
                "format": "uuid"
              },
              "status": {
                "type": "string",
                "enum": [
                  "QUEUED",
                  "UNCERTAIN"
                ]
              },
              "replayed": {
                "type": "boolean"
              },
              "journalRecorded": {
                "type": "boolean"
              }
            }
          }
        }
      },
      "ReminderHistoryListResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data",
          "total",
          "limit",
          "offset",
          "hasMore"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "maxItems": 100,
            "items": {
              "$ref": "#/components/schemas/ReminderHistoryEntry"
            }
          },
          "total": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2000
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2000
          },
          "hasMore": {
            "type": "boolean"
          }
        }
      },
      "ReminderHistoryEntry": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "channel",
          "nativeReminderId",
          "type",
          "audience",
          "contactIds",
          "relationBasis",
          "state",
          "queueStatus",
          "deliveryStatus",
          "subject",
          "recordedAt",
          "processedAt",
          "deliveryUpdatedAt",
          "errorCode"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "channel": {
            "type": "string",
            "enum": [
              "EMAIL"
            ]
          },
          "nativeReminderId": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "nullable": true,
            "enum": [
              "BIRTHDAY",
              "HAZKARA",
              null
            ]
          },
          "audience": {
            "type": "string",
            "enum": [
              "CONTACT",
              "RESPONSIBLE"
            ]
          },
          "contactIds": {
            "type": "array",
            "maxItems": 200,
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "relationBasis": {
            "type": "string",
            "enum": [
              "STORED_METADATA",
              "ADMITTED_LEGACY_SOURCE"
            ]
          },
          "state": {
            "type": "string",
            "nullable": true,
            "enum": [
              "INIT",
              "SUCCESS",
              "ERROR",
              null
            ]
          },
          "queueStatus": {
            "type": "string",
            "enum": [
              "QUEUED",
              "ACCEPTED",
              "ERROR",
              "UNKNOWN"
            ]
          },
          "deliveryStatus": {
            "type": "string",
            "nullable": true,
            "enum": [
              "ACCEPTED",
              "DELIVERED",
              "RELAYED",
              "DELAYED",
              "ERROR",
              "EXPANDED",
              "UNKNOWN",
              null
            ]
          },
          "subject": {
            "type": "string",
            "nullable": true
          },
          "recordedAt": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          },
          "processedAt": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          },
          "deliveryUpdatedAt": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "ReminderHistoryResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/ReminderHistoryEntry"
          }
        }
      },
      "TransactionalReminderListResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "asOf",
          "data",
          "total",
          "limit",
          "offset",
          "hasMore"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "data": {
            "type": "array",
            "maxItems": 100,
            "items": {
              "$ref": "#/components/schemas/TransactionalReminderRule"
            }
          },
          "total": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2000
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2000
          },
          "hasMore": {
            "type": "boolean"
          }
        }
      },
      "TransactionalReminderRule": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "type",
          "source",
          "subjectContactId",
          "subjectName",
          "configuredRecipientContactId",
          "recipientContactIds",
          "notifyRecipient",
          "customText",
          "hebrewDay",
          "hebrewMonth",
          "revision",
          "mutableFields",
          "calendarStatus",
          "nextDate",
          "nextHebrewDate",
          "timeZone",
          "timeZoneBasis",
          "management"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string",
            "enum": [
              "BIRTHDAY",
              "HAZKARA"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "CONTACT",
              "CONTACT_RECIPIENT",
              "LEGACY"
            ]
          },
          "subjectContactId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "subjectName": {
            "type": "string",
            "nullable": true
          },
          "configuredRecipientContactId": {
            "type": "string",
            "nullable": true,
            "format": "uuid"
          },
          "recipientContactIds": {
            "type": "array",
            "maxItems": 100,
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "notifyRecipient": {
            "type": "boolean",
            "nullable": true
          },
          "customText": {
            "type": "string",
            "maxLength": 10000
          },
          "hebrewDay": {
            "type": "integer",
            "minimum": 1,
            "maximum": 30
          },
          "hebrewMonth": {
            "type": "string"
          },
          "revision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "mutableFields": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "notifyRecipient",
                "customText"
              ]
            }
          },
          "calendarStatus": {
            "type": "string",
            "enum": [
              "AVAILABLE",
              "UNAVAILABLE"
            ]
          },
          "nextDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "nextHebrewDate": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "day",
              "month",
              "year"
            ],
            "properties": {
              "day": {
                "type": "integer",
                "minimum": 1,
                "maximum": 30
              },
              "month": {
                "type": "string"
              },
              "year": {
                "type": "integer"
              }
            },
            "nullable": true
          },
          "timeZone": {
            "type": "string",
            "nullable": true
          },
          "timeZoneBasis": {
            "type": "string",
            "enum": [
              "SERVER_LOCAL"
            ]
          },
          "management": {
            "type": "string",
            "enum": [
              "SUPPORTED",
              "DERIVED_RULE"
            ]
          }
        }
      },
      "TransactionalReminderRuleResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "asOf",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "data": {
            "$ref": "#/components/schemas/TransactionalReminderRule"
          }
        }
      },
      "TransactionalReminderChangeResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "requestId",
              "type",
              "source",
              "id",
              "status",
              "revision",
              "error",
              "replayed",
              "journalRecorded"
            ],
            "properties": {
              "requestId": {
                "type": "string",
                "format": "uuid"
              },
              "type": {
                "type": "string",
                "enum": [
                  "BIRTHDAY",
                  "HAZKARA"
                ]
              },
              "source": {
                "type": "string",
                "enum": [
                  "CONTACT",
                  "CONTACT_RECIPIENT",
                  "LEGACY"
                ]
              },
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "status": {
                "type": "string",
                "enum": [
                  "PENDING",
                  "SUCCEEDED",
                  "REFUSED",
                  "UNCERTAIN"
                ]
              },
              "revision": {
                "type": "string",
                "nullable": true,
                "pattern": "^[a-f0-9]{64}$"
              },
              "error": {
                "type": "string",
                "nullable": true,
                "enum": [
                  "REMINDER_REVISION_CHANGED",
                  "REMINDER_CHANGE_UNCERTAIN",
                  "REMINDER_CHANGE_PENDING",
                  null
                ]
              },
              "replayed": {
                "type": "boolean"
              },
              "journalRecorded": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API Key",
        "description": "Format: `ke_live_xxx`"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}
```
