GET
/
user
/
optin
/
{id}
cURL
curl --request GET \
  --url https://flatbay.fr/fr/api/user/optin/{id}
{
  "status": "ok"
}
/api/user/optin/:id?apiKey=xxxxx
Il faudra que l’équipe Flatbay vous fournisse une clé d’API pour utiliser cette route. Cette route permet d’activer ou de désactiver l’optin pour un utilisateur sur tous les établissements de votre groupe.

​
Comportement

  • Si le paramètre optin a la valeur optin, l’optin est activé pour l’utilisateur
  • Sinon, l’optin est désactivé

​
Exemple d’utilisation

Activer l’optin: 
GET /api/user/optin/123?apiKey=xxxxx&optin=optin
Désactiver l’optin: 
GET /api/user/optin/123?apiKey=xxxxx

​
Codes d’erreur

CodeDescription
BADPARAMSuserId manquant
NOAPIKEYClé API manquante
USERNOTINGROUPL’utilisateur n’appartient pas à votre groupe

Path Parameters

​
id
integer
required

Identifiant de l'utilisateur Id de l'utilisateur qui a vu/partagé le bien

Example:

125

Query Parameters

​
apiKey
string
required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

​
optin
string

Si la valeur est 'optin', active l'optin pour l'utilisateur. Sinon, désactive l'optin.

Example:

"optin"

Response

Optin mis à jour avec succès

Retour positif du serveur

​
status
string

Statut de la requête

Example:

"ok"