Aller au contenu principal

PATCH /bot/update-birthday

version 2.0.0

Modifier l’anniversaire d’une personne.

Authentification

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 :

NomTypeDansRequisDescription
discordIdstringBodyL'identifiant Discord de la personne
birthdaystringBodyNouvelle date d’anniversaire (YYYY-MM-DD)

🧾 Réponse

Les données que l'API retournera avec le succès de la requête :

NomTypeNullableDescription
discordIdstringL'identifiant Discord de la personne
birthdaystringLa date d’anniversaire (format YYYY-MM-DD)

📤 Exemple de requête

Voici un exemple de requête pour modifier un anniversaire :

http://0.0.0.0/api/bot/update-birthday

Et dans le body mettre par exemple :

{
"discordId": "213350119184138241",
"birthday": "2002-05-15"
}

📥 Exemple de réponse

Si la mise à jour est réussie (code 200) :

{
"discordId": "213350119184138241",
"birthday": "2002-05-15"
}

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
404Not foundEntité introuvable
500Internal Server ErrorErreur interne du serveur
Attention !

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

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe message de l'API expliquant l'erreur

Exemple avec l'erreur 404 Not found :

Ici par exemple, l'erreur 404 signifie que l'anniversaire n'a pas été trouvé dans la base de données.

{
"message": "No value present",
"code": 404
}