**Versions de l’API** · **V2 (Latest)** · [V1](/integrations/v1/docs?lang=fr)

# Transactional Reminders

OpenAPI 3.0.3 · API 2.0.0

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

## Opérations

## POST /transactional-reminders/preview

Prévisualiser un rappel email natif pour un destinataire configuré

`preview_one_off_reminder`

Les autorisations transactional_reminders:read ET contacts:read sont requises ; l’envoi exige en plus le droit explicite indépendant transactional_reminders:send. messages:send et contacts:write ne remplacent pas ces droits. Résoudre une règle existante avec list/get_transactional_reminder_rules et choisir un recipientContactId de son tableau natif recipientContactIds ; un enfant configuré peut être routé vers ses parents. Ce parcours ponctuel EMAIL ne choisit pas de contact sans relation, ne crée pas de règle, ne modifie pas les réglages récurrents et ne définit pas de nouveau calendrier religieux. Les lignes dérivées CONTACT HAZKARA de récapitulatif n’ont pas de parcours destinataire ici. Un envoi ponctuel explicitement demandé peut cibler un destinataire admis même lorsque la notification automatique est désactivée ; il n’active pas la règle de fond. Toutes les relations sujet, destinataire configuré, parent et récapitulatif sont réadmises dans l’organisation ; les clés limitées aux collectes sont refusées. Sujet, corps, HTML et langue du destinataire réutilisent le builder natif et la sélection actuelle d’expéditeur. L’HTML est un aperçu, pas un code d’interface fiable : utiliser un bac à sable pour l’afficher. Aucune adresse/téléphone privé du destinataire, configuration SMTP, session ni réponse prestataire n’est retournée. Le modèle peut naturellement contenir la signature du contact de l’organisation utilisée dans le rappel réel. nextDate et calendarTimeZone identifient le calcul natif d’anniversaire dans le fuseau local du serveur, pas un horaire d’envoi ni le fuseau d’affichage de l’organisation. La fenêtre de commémoration réutilise les calculs natifs Hebcal TSET ; dates/canaux/expéditeurs indisponibles renvoient 409, jamais une date inventée ni un nouveau destinataire. emailConfig=null signifie sélection de repli native au moment du transport, pas garantie d’un expéditeur précis. Un aperçu ne vérifie ni identifiants SMTP, ni consentement, ni délivrabilité. Ce POST est une lecture/prévisualisation pure : aucun envoi, journal, insertion en file, appel prestataire ni initialisation persistante de calendrier. Conserver previewRevision avec le contenu natif affiché ; un envoi ultérieur doit transmettre cette révision inchangée. Les variables propres à l’envoi comme {{mailing_unsubscribe}} peuvent rester littérales dans l’aperçu ; elles sont rendues une seule fois avec l’identifiant déterministe réel uniquement lors de la mise en file.

### Authentification

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

### Permissions requises

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

### Corps de la requête

```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
      }
    }
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "Aperçu natif pur ; aucune écriture de journal ni de queue.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderPreviewResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_REMINDER_DELIVERY ou type/source/id de règle invalide.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification requise.",
  "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 ou 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 ou règle/référence/historique indisponible. Ne pas contourner le destinataire choisi ni réessayer un envoi incertain.",
  "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. Une erreur de transport ne prouve pas l’échec d’une mise en file.",
  "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

Mettre en file un rappel email ponctuel explicitement demandé

`send_one_off_reminder`

Les autorisations transactional_reminders:read ET contacts:read sont requises ; l’envoi exige en plus le droit explicite indépendant transactional_reminders:send. messages:send et contacts:write ne remplacent pas ces droits. Résoudre une règle existante avec list/get_transactional_reminder_rules et choisir un recipientContactId de son tableau natif recipientContactIds ; un enfant configuré peut être routé vers ses parents. Ce parcours ponctuel EMAIL ne choisit pas de contact sans relation, ne crée pas de règle, ne modifie pas les réglages récurrents et ne définit pas de nouveau calendrier religieux. Les lignes dérivées CONTACT HAZKARA de récapitulatif n’ont pas de parcours destinataire ici. Un envoi ponctuel explicitement demandé peut cibler un destinataire admis même lorsque la notification automatique est désactivée ; il n’active pas la règle de fond. Toutes les relations sujet, destinataire configuré, parent et récapitulatif sont réadmises dans l’organisation ; les clés limitées aux collectes sont refusées. Sujet, corps, HTML et langue du destinataire réutilisent le builder natif et la sélection actuelle d’expéditeur. L’HTML est un aperçu, pas un code d’interface fiable : utiliser un bac à sable pour l’afficher. Aucune adresse/téléphone privé du destinataire, configuration SMTP, session ni réponse prestataire n’est retournée. Le modèle peut naturellement contenir la signature du contact de l’organisation utilisée dans le rappel réel. nextDate et calendarTimeZone identifient le calcul natif d’anniversaire dans le fuseau local du serveur, pas un horaire d’envoi ni le fuseau d’affichage de l’organisation. La fenêtre de commémoration réutilise les calculs natifs Hebcal TSET ; dates/canaux/expéditeurs indisponibles renvoient 409, jamais une date inventée ni un nouveau destinataire. emailConfig=null signifie sélection de repli native au moment du transport, pas garantie d’un expéditeur précis. Un aperçu ne vérifie ni identifiants SMTP, ni consentement, ni délivrabilité. Obtenir d’abord un aperçu récent puis transmettre son previewRevision exact et un nouvel UUID idempotencyKey pour ce destinataire/message explicitement autorisé. Un changement de contenu, preuve destinataire, langue, règle ou sélection d’expéditeur peut invalider l’aperçu avec REMINDER_PREVIEW_CHANGED avant mise en file. Une commande durable liée au principal et à l’organisation est insérée avant l’entrée native send ; identifiant d’envoi et identité de queue sont déterministes. La même clé et la même demande sont relues sans nouvel envoi en file ; une demande différente avec cette clé renvoie IDEMPOTENCY_CONFLICT. QUEUED signifie insertion acquittée dans la queue native EMAIL, pas acceptation SMTP, livraison ni lecture. UNCERTAIN couvre un acquittement ambigu ou une commande interrompue ; il n’autorise jamais un réessai automatique ni une nouvelle clé. Le rejeu d’un journal PENDING/UNCERTAIN reste UNCERTAIN et ne remet rien en file. Consulter get_reminder_email_history avec sendId pour les observations enregistrées ultérieurement, mais un 404 ne prouve pas qu’un envoi incertain n’a pas eu lieu. journalRecorded=false signifie que l’acquittement final du journal a échoué et la commande renvoie UNCERTAIN. Cela n’autorise jamais une autre insertion. QUEUED exige l’insertion acquittée de la file déterministe et le journal durable final, sans prouver l’acceptation SMTP ni la livraison. Cette opération n’appelle pas SMTP/prestataire ; le worker indépendant existant traite ensuite la queue et peut la refuser selon ses propres règles.

### Authentification

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

### Permissions requises

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

### Corps de la requête

```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
      }
    }
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "Acquittement de queue ou résultat de mise en file explicitement inconnu ; jamais livré.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderSendResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_REMINDER_DELIVERY ou type/source/id de règle invalide.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification requise.",
  "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 ou 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 ou règle/référence/historique indisponible. Ne pas contourner le destinataire choisi ni réessayer un envoi incertain.",
  "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. Une erreur de transport ne prouve pas l’échec d’une mise en file.",
  "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

Consulter l’historique email des rappels et leurs états de livraison enregistrés

`list_reminder_email_history`

Les autorisations transactional_reminders:read ET contacts:read sont requises ; messages:* seul ne donne pas accès. Historique EMAIL en lecture seule des anniversaires/hazkarot, y compris les anciennes sources annuelles réadmises. Les rappels personnalisés personnels/globaux, SMS, WhatsApp et push ne sont pas couverts par cette tranche native d’historique email ; une réponse vide ne prouve pas l’absence d’envoi sur un autre canal. Aucun envoi, mise en file, régénération, réessai, interrogation prestataire, appel SMTP ni écriture de calendrier n’a lieu. Les reminder.contactIds enregistrés sont admis indépendamment comme références CRM actuelles exactes dans cette organisation ; les sources historiques sans métadonnées doivent résoudre des contacts/références historiques actuellement admissibles, sinon 409. Une relation absente, supprimée, étrangère ou ambiguë refuse la projection au lieu de retirer des destinataires privés. Les clés limitées à des collectes sont refusées faute d’appartenance CRM indépendante. nativeReminderId est la référence enregistrée du propriétaire et peut identifier un contact/défunt ou une ancienne règle ; ce n’est pas nécessairement l’UUID de règle externe CONTACT_RECIPIENT. type=null signifie que la source historique n’établit pas anniversaire ou hazkara ; ne jamais deviner. INIT/QUEUED signifie en file, SUCCESS/ACCEPTED signifie acceptation SMTP enregistrée par le worker, pas livraison finale ni lecture. ERROR peut enregistrer un échec certain ou MAILER_DELIVERY_UNCERTAIN ; aucun de ces états ne donne le droit de réessayer. deliveryStatus est uniquement l’observation SMTP/DSN enregistrée, null lorsqu’elle est indisponible ; DELIVERED ne prouve pas une lecture humaine. Les états/dates inconnus restent null ou UNKNOWN, jamais un instant inventé. Les dates sont des instants ISO. Aucune adresse destinataire, téléphone, diagnostic brut prestataire/SMTP, HTML, source privée brute ni session n’est renvoyé. La liste est bornée à 2000 entrées enregistrées ; au-delà, REMINDER_HISTORY_LIMIT_EXCEEDED est renvoyé sans historique partiel. Limit/offset utilisent recordedAt décroissant puis id ; les lectures ne sont pas une photographie transactionnelle. L’authentification peut mettre à jour les statistiques d’usage de la clé API.

### Authentification

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

### Permissions requises

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

### Paramètres

```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
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "Uniquement les observations enregistrées de file email et de livraison.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderHistoryListResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "UUID, requête ou corps invalide.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification requise.",
  "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 ou 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 ou REMINDER_HISTORY_LIMIT_EXCEEDED ; aucun historique partiel ni autorisation de réessai.",
  "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. Aucune livraison n’a été tentée.",
  "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}

Consulter l’état enregistré d’un email de rappel

`get_reminder_email_history`

Les autorisations transactional_reminders:read ET contacts:read sont requises ; messages:* seul ne donne pas accès. Historique EMAIL en lecture seule des anniversaires/hazkarot, y compris les anciennes sources annuelles réadmises. Les rappels personnalisés personnels/globaux, SMS, WhatsApp et push ne sont pas couverts par cette tranche native d’historique email ; une réponse vide ne prouve pas l’absence d’envoi sur un autre canal. Aucun envoi, mise en file, régénération, réessai, interrogation prestataire, appel SMTP ni écriture de calendrier n’a lieu. Les reminder.contactIds enregistrés sont admis indépendamment comme références CRM actuelles exactes dans cette organisation ; les sources historiques sans métadonnées doivent résoudre des contacts/références historiques actuellement admissibles, sinon 409. Une relation absente, supprimée, étrangère ou ambiguë refuse la projection au lieu de retirer des destinataires privés. Les clés limitées à des collectes sont refusées faute d’appartenance CRM indépendante. nativeReminderId est la référence enregistrée du propriétaire et peut identifier un contact/défunt ou une ancienne règle ; ce n’est pas nécessairement l’UUID de règle externe CONTACT_RECIPIENT. type=null signifie que la source historique n’établit pas anniversaire ou hazkara ; ne jamais deviner. INIT/QUEUED signifie en file, SUCCESS/ACCEPTED signifie acceptation SMTP enregistrée par le worker, pas livraison finale ni lecture. ERROR peut enregistrer un échec certain ou MAILER_DELIVERY_UNCERTAIN ; aucun de ces états ne donne le droit de réessayer. deliveryStatus est uniquement l’observation SMTP/DSN enregistrée, null lorsqu’elle est indisponible ; DELIVERED ne prouve pas une lecture humaine. Les états/dates inconnus restent null ou UNKNOWN, jamais un instant inventé. Les dates sont des instants ISO. Aucune adresse destinataire, téléphone, diagnostic brut prestataire/SMTP, HTML, source privée brute ni session n’est renvoyé. La liste est bornée à 2000 entrées enregistrées ; au-delà, REMINDER_HISTORY_LIMIT_EXCEEDED est renvoyé sans historique partiel. Limit/offset utilisent recordedAt décroissant puis id ; les lectures ne sont pas une photographie transactionnelle. L’authentification peut mettre à jour les statistiques d’usage de la clé API.

### Authentification

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

### Permissions requises

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

### Paramètres

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

### Réponses

#### HTTP 200

```json
{
  "description": "Uniquement les observations enregistrées de file email et de livraison.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReminderHistoryResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "UUID, requête ou corps invalide.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification requise.",
  "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 ou 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 ou REMINDER_HISTORY_LIMIT_EXCEEDED ; aucun historique partiel ni autorisation de réessai.",
  "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. Aucune livraison n’a été tentée.",
  "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

Consulter les règles d’anniversaire et de hazkara et leurs prochaines dates

`list_transactional_reminder_rules`

Les deux autorisations transactional_reminders:read ET contacts:read sont requises. Consulte les règles existantes d’anniversaire et de hazkara (anniversaire hébraïque de décès), sans envoi, mise en file, réessai, régénération de rappel, initialisation de calendrier, appel prestataire ni modification CRM. BIRTHDAY suit le propriétaire natif ANNIV ; HAZKARA suit le propriétaire natif du contact décédé ou du rappel historique. source CONTACT avec BIRTHDAY utilise l’identifiant du contact ; CONTACT avec HAZKARA utilise celui du défunt et représente le récapitulatif réservé au responsable, pas une règle de destinataire. CONTACT_RECIPIENT désigne une règle de destinataire existante dans contact.rappels : son id diffère de subjectContactId, et notifyRecipient vaut toujours true selon le worker natif ; aucun interrupteur silence fictif n’est ajouté. LEGACY utilise l’identifiant du rappel enregistré ; un ancien anniversaire masqué par un contact doté d’une date de naissance est absent. recipientContactIds contient des références CRM admises, jamais des numéros de téléphone ni des adresses email. configuredRecipientContactId identifie le contact CRM directement configuré ; recipientContactIds suit le routage natif vers les parents admis non décédés lorsque ce contact possède des parents, pour les anniversaires comme pour les règles de hazkara. notifyRecipient=false désactive les notifications aux destinataires, pas le récapitulatif du responsable de l’organisation. notifyRecipient à null signifie sans objet. Il s’agit de configuration, pas d’un consentement, d’une disponibilité de canal, d’un état de livraison ni d’une promesse d’envoi. customText est le texte enregistré ; un anniversaire réservé au responsable peut conserver un customText inactif. Les dates hébraïques et le prochain anniversaire réutilisent le propriétaire rappel/Hebcal existant, y compris ses conventions historiques de coucher du soleil/midi et de mois courts, sans définir de nouvelle règle de calendrier religieux. nextDate est un jour civil YYYY-MM-DD, pas un instant d’envoi ; timeZone est le fuseau local réellement utilisé par le serveur pour le calcul, jamais un fuseau d’organisation déduit. calendarStatus=UNAVAILABLE renvoie nextDate/nextHebrewDate à null ; ne jamais substituer une date ni un fuseau. Les données historiques inconnues ou mal formées entraînent 409 au lieu d’une coercition ou d’une autorisation implicite. Tous les contacts liés sont admis indépendamment dans l’organisation courante ; une relation absente, supprimée, étrangère ou ambiguë interdit la projection. Les clés limitées à des collectes sont refusées avec CAMPAIGN_RESTRICTED_KEY car ce domaine CRM ne possède pas de propriétaire indépendant d’appartenance aux collectes. Au plus 5000 contacts et 2000 règles effectives/brutes sont admis ; au-delà, REMINDER_READ_LIMIT_EXCEEDED est renvoyé sans résultat partiel. revision est une empreinte opaque de la configuration observée, pas un entier ni un verrou transactionnel. management=SUPPORTED et mutableFields décrivent les réglages modifiables par cette façade avec des autorisations d’écriture accordées séparément ; management=DERIVED_RULE signifie que le récapitulatif natif du responsable ne possède pas de réglage indépendant. La surface n’expose ni création, ni suppression, ni modification des dates CRM, ni configuration de fréquence/expéditeur de l’organisation, ni historique, ni envoi ponctuel. Utiliser les outils vivants distincts pour les domaines disponibles indépendamment ; messages:* seul ne donne jamais accès aux rappels ni aux contacts. L’authentification peut mettre à jour les statistiques d’usage de la clé API.

### Authentification

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

### Permissions requises

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

### Paramètres

```json
{
  "name": "type",
  "in": "query",
  "description": "Type de règle facultatif ; anniversaires et hazkarot utilisent le propriétaire des anniversaires hébraïques.",
  "schema": {
    "type": "string",
    "enum": [
      "BIRTHDAY",
      "HAZKARA"
    ]
  }
}
```

```json
{
  "name": "contactId",
  "in": "query",
  "description": "UUID facultatif du contact CRM sujet ou destinataire. Ne recherche pas les coordonnées privées du contact.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "limit",
  "in": "query",
  "description": "Nombre maximal de règles renvoyées après filtrage.",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 100,
    "default": 50
  }
}
```

```json
{
  "name": "offset",
  "in": "query",
  "description": "Décalage dans l’ordre type/source/id filtré. Il ne s’agit pas d’une photographie transactionnelle.",
  "schema": {
    "type": "integer",
    "minimum": 0,
    "maximum": 2000,
    "default": 0
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "Règles de rappel limitées aux champs autorisés et observations natives des prochains anniversaires.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TransactionalReminderListResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Type, source, UUID ou paramètre de requête invalide, ou corps de requête inattendu.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification absente ou invalide.",
  "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 ou CAMPAIGN_RESTRICTED_KEY ; aucune donnée de rappel ni de contact n’est renvoyée.",
  "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 : la règle effective demandée est absente ou extérieure à l’organisation courante.",
  "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 ou REMINDER_READ_LIMIT_EXCEEDED. Vérifier les données enregistrées dans leur application propriétaire ; aucun envoi ni réessai n’est autorisé.",
  "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. Aucune livraison de rappel n’a été tentée.",
  "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}

Consulter une règle existante d’anniversaire ou de hazkara

`get_transactional_reminder_rule`

Les deux autorisations transactional_reminders:read ET contacts:read sont requises. Consulte les règles existantes d’anniversaire et de hazkara (anniversaire hébraïque de décès), sans envoi, mise en file, réessai, régénération de rappel, initialisation de calendrier, appel prestataire ni modification CRM. BIRTHDAY suit le propriétaire natif ANNIV ; HAZKARA suit le propriétaire natif du contact décédé ou du rappel historique. source CONTACT avec BIRTHDAY utilise l’identifiant du contact ; CONTACT avec HAZKARA utilise celui du défunt et représente le récapitulatif réservé au responsable, pas une règle de destinataire. CONTACT_RECIPIENT désigne une règle de destinataire existante dans contact.rappels : son id diffère de subjectContactId, et notifyRecipient vaut toujours true selon le worker natif ; aucun interrupteur silence fictif n’est ajouté. LEGACY utilise l’identifiant du rappel enregistré ; un ancien anniversaire masqué par un contact doté d’une date de naissance est absent. recipientContactIds contient des références CRM admises, jamais des numéros de téléphone ni des adresses email. configuredRecipientContactId identifie le contact CRM directement configuré ; recipientContactIds suit le routage natif vers les parents admis non décédés lorsque ce contact possède des parents, pour les anniversaires comme pour les règles de hazkara. notifyRecipient=false désactive les notifications aux destinataires, pas le récapitulatif du responsable de l’organisation. notifyRecipient à null signifie sans objet. Il s’agit de configuration, pas d’un consentement, d’une disponibilité de canal, d’un état de livraison ni d’une promesse d’envoi. customText est le texte enregistré ; un anniversaire réservé au responsable peut conserver un customText inactif. Les dates hébraïques et le prochain anniversaire réutilisent le propriétaire rappel/Hebcal existant, y compris ses conventions historiques de coucher du soleil/midi et de mois courts, sans définir de nouvelle règle de calendrier religieux. nextDate est un jour civil YYYY-MM-DD, pas un instant d’envoi ; timeZone est le fuseau local réellement utilisé par le serveur pour le calcul, jamais un fuseau d’organisation déduit. calendarStatus=UNAVAILABLE renvoie nextDate/nextHebrewDate à null ; ne jamais substituer une date ni un fuseau. Les données historiques inconnues ou mal formées entraînent 409 au lieu d’une coercition ou d’une autorisation implicite. Tous les contacts liés sont admis indépendamment dans l’organisation courante ; une relation absente, supprimée, étrangère ou ambiguë interdit la projection. Les clés limitées à des collectes sont refusées avec CAMPAIGN_RESTRICTED_KEY car ce domaine CRM ne possède pas de propriétaire indépendant d’appartenance aux collectes. Au plus 5000 contacts et 2000 règles effectives/brutes sont admis ; au-delà, REMINDER_READ_LIMIT_EXCEEDED est renvoyé sans résultat partiel. revision est une empreinte opaque de la configuration observée, pas un entier ni un verrou transactionnel. management=SUPPORTED et mutableFields décrivent les réglages modifiables par cette façade avec des autorisations d’écriture accordées séparément ; management=DERIVED_RULE signifie que le récapitulatif natif du responsable ne possède pas de réglage indépendant. La surface n’expose ni création, ni suppression, ni modification des dates CRM, ni configuration de fréquence/expéditeur de l’organisation, ni historique, ni envoi ponctuel. Utiliser les outils vivants distincts pour les domaines disponibles indépendamment ; messages:* seul ne donne jamais accès aux rappels ni aux contacts. L’authentification peut mettre à jour les statistiques d’usage de la clé API.

### Authentification

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

### Permissions requises

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

### Paramètres

```json
{
  "name": "type",
  "in": "path",
  "required": true,
  "description": "Type exact renvoyé par list_transactional_reminder_rules.",
  "schema": {
    "type": "string",
    "enum": [
      "BIRTHDAY",
      "HAZKARA"
    ]
  }
}
```

```json
{
  "name": "source",
  "in": "path",
  "required": true,
  "description": "Source exacte renvoyée par la liste ; CONTACT_RECIPIENT est valide uniquement avec HAZKARA.",
  "schema": {
    "type": "string",
    "enum": [
      "CONTACT",
      "CONTACT_RECIPIENT",
      "LEGACY"
    ]
  }
}
```

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "UUID de règle renvoyé par la liste ; un id CONTACT_RECIPIENT ne désigne pas l’identifiant du défunt sujet.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "Règles de rappel limitées aux champs autorisés et observations natives des prochains anniversaires.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TransactionalReminderRuleResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Type, source, UUID ou paramètre de requête invalide, ou corps de requête inattendu.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification absente ou invalide.",
  "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 ou CAMPAIGN_RESTRICTED_KEY ; aucune donnée de rappel ni de contact n’est renvoyée.",
  "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 : la règle effective demandée est absente ou extérieure à l’organisation courante.",
  "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 ou REMINDER_READ_LIMIT_EXCEEDED. Vérifier les données enregistrées dans leur application propriétaire ; aucun envoi ni réessai n’est autorisé.",
  "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. Aucune livraison de rappel n’a été tentée.",
  "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}

Modifier les réglages pris en charge d’une règle existante d’anniversaire ou de hazkara

`update_transactional_reminder_rule`

Toutes les autorisations transactional_reminders:write, transactional_reminders:read, contacts:read et contacts:write sont requises. Modifier uniquement les réglages indiqués dans mutableFields par une lecture récente de la règle. CONTACT BIRTHDAY et les règles LEGACY acceptent notifyRecipient et customText. CONTACT_RECIPIENT HAZKARA accepte uniquement customText ; son worker natif s’adresse toujours à son destinataire existant et ignore silence. CONTACT HAZKARA est un récapitulatif dérivé du responsable qui ne peut pas être activé, désactivé ni modifié indépendamment. Cet adaptateur modifie exactement les réglages natifs existants rappelAnniv, rappels[].text ou les anciens silence/text avec comparaison avant écriture ; il ne crée ni ne supprime de règle, ne modifie aucune date de naissance/décès CRM, ne choisit pas de nouveau destinataire, ne configure pas la fréquence/l’expéditeur de l’organisation, n’envoie rien, ne met rien en file, ne régénère rien, ne réessaie aucune livraison et n’appelle aucun prestataire. notifyRecipient=false désactive uniquement le parcours destinataire ; il ne désactive jamais le récapitulatif du responsable. customText reste enregistré même lorsque la notification destinataire est désactivée. L’activation d’une règle peut permettre à un passage ultérieur indépendant du worker natif d’envoyer des rappels : c’est une modification persistante de réglage, pas un envoi ponctuel. Résoudre d’abord type/source/id avec list/get ; transmettre sa revision opaque de 64 caractères dans expectedRevision et un nouvel UUID idempotencyKey pour la modification explicitement demandée. Les clés inconnues, types incorrects et champs non pris en charge sont refusés. Toutes les références de sujet, destinataire, parent et récapitulatif sont réadmises dans l’organisation authentifiée ; les clés limitées à des collectes sont refusées. Une révision différente renvoie 409 avant mutation, ou status REFUSED avec REMINDER_REVISION_CHANGED si une écriture concurrente gagne la comparaison. Lire la configuration courante et obtenir une nouvelle modification demandée par l’utilisateur avant de soumettre une commande modifiée. La même clé et la même charge relisent la commande liée au principal et à l’organisation sans réexécuter la mutation ; une charge différente avec cette clé renvoie IDEMPOTENCY_CONFLICT. success=true qualifie l’enveloppe de commande, pas nécessairement un réglage appliqué : examiner status. SUCCEEDED confirme l’écriture native des réglages ; PENDING ou UNCERTAIN n’autorise jamais un réessai avec une nouvelle clé ni une exécution automatique. Relire la règle et rejouer la clé identique pour consulter la commande enregistrée ; elle peut rester PENDING si son enregistrement a été interrompu. journalRecorded=false signifie que l’acquittement durable final du journal est indisponible : la commande renvoie UNCERTAIN et ne permet jamais de rejeu automatique ; une relecture ultérieure peut rester PENDING. Ne jamais déduire de cette modification un consentement email, la possibilité de joindre une personne, une livraison, un instant d’envoi ni une nouvelle règle de calendrier religieux. Le contrat de lecture décrit les limites natives de date et de fuseau.

### Authentification

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

### Permissions requises

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

### Paramètres

```json
{
  "name": "type",
  "in": "path",
  "required": true,
  "description": "Type exact renvoyé par list_transactional_reminder_rules.",
  "schema": {
    "type": "string",
    "enum": [
      "BIRTHDAY",
      "HAZKARA"
    ]
  }
}
```

```json
{
  "name": "source",
  "in": "path",
  "required": true,
  "description": "Source exacte renvoyée par la liste ; CONTACT_RECIPIENT est valide uniquement avec HAZKARA.",
  "schema": {
    "type": "string",
    "enum": [
      "CONTACT",
      "CONTACT_RECIPIENT",
      "LEGACY"
    ]
  }
}
```

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "UUID de règle renvoyé par la liste ; un id CONTACT_RECIPIENT ne désigne pas l’identifiant du défunt sujet.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Corps de la requête

```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
      }
    }
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "Règles de rappel limitées aux champs autorisés et observations natives des prochains anniversaires.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TransactionalReminderChangeResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Type, source, UUID ou paramètre de requête invalide, ou corps de requête inattendu.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentification absente ou invalide.",
  "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 ou CAMPAIGN_RESTRICTED_KEY ; aucune donnée de rappel ni de contact n’est renvoyée.",
  "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 : la règle effective demandée est absente ou extérieure à l’organisation courante.",
  "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 ou règle/référence/calendrier enregistré indisponible. Aucun réglage non pris en charge n’est modifié ; consulter la règle courante avant d’effectuer une autre modification demandée.",
  "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. Aucune livraison de rappel n’a été tentée.",
  "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
  }
}
```

## Schémas

```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"
      }
    }
  }
}
```
