POST /bot/create-birthday
Créer un anniversaire pour une personne.
Cette route nécessite de mettre votre clé API dans le Header.
👥 Autorisation
Les personnes autorisées pour utiliser cette requête sont :
- Corail
- Zelta
🧾 Paramètres
Les champs suivants sont attendus dans le corps de la requête :
| Nom | Type | Dans | Requis | Description | Valeur par default |
|---|---|---|---|---|---|
discordId | string | Body | ✅ | L'identifiant Discord de la personne | ❌ |
birthday | string | Body | ✅ | La date d’anniversaire (format YYYY-MM-DD) | ❌ |
🧾 Réponse
Les données que l'API retournera avec le succès de la requête :
| Nom | Type | Nullable | Description |
|---|---|---|---|
discordId | string | ❌ | L'identifiant Discord de la personne |
birthday | string | ❌ | La date d’anniversaire (format YYYY-MM-DD) |
📤 Exemple de requête
Voici un exemple d’appel à cette route :
http://0.0.0.0/api/bot/create-birthday
Et dans le body mettre par exemple :
{
"discordId": "213350119184138241",
"birthday": "2000-01-01"
}
📥 Exemple de réponse
Si l’anniversaire est bien créé (code 201) :
{
"discordId": "213350119184138241",
"birthday": "2000-01-01"
}
⛔ Les erreurs
Les différents types d'erreurs :
| Code HTTP | Description | Cause possible |
|---|---|---|
| 400 | Bad Request | Paramètres manquants ou invalides |
| 401 | Unauthorized | Clé API manquante ou invalide |
| 403 | Forbidden | Droits insuffisants pour utiliser la requête |
| 409 | Conflict | Conflit avec des données existantes |
| 500 | Internal Server Error | Erreur interne du serveur |
En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !
En cas d'erreur voici les informations que retourne l'API
| Nom | Type | Description |
|---|---|---|
code | number | Le code d'erreur que retourne la requête |
message | string | Le message de l'API expliquant l'erreur |
Exemple avec l'erreur 409 Conflict :
Ici par exemple, l'erreur 409 signifie que la base de donnée a rencontré une erreur lors de l'ajout
du nouvel anniversaire. Dans notre cas, l'id 213350119184138241 est déjà enregistré.
{
"message": "A birthday with the discordId '213350119184138241' already exists",
"code": 409
}