Synup
Créer une clé
v1Ressources/Clients/getConsulter la marque du portail client

Consulter la marque du portail client

Consulter ou remplacer le logo, la couleur, le favicon et le ton du portail comme un ensemble complet. customized=false efface les personnalisations et reprend les valeurs de l’agence. Un utilisateur identifié doit accéder à Clients et à ce client; les restrictions du jeton s’appliquent aussi.

get/api/v1/clients/{id}/portal-brand
clients:read
Paramètres de requête
idstringobligatoire
Réponse
dataobjectobligatoire
customizedbooleanfacultatif
overrideobjectfacultatif
logoUrlstringfacultatif
colorHexstringfacultatif
faviconUrlstringfacultatif
logoTonestring (dark | light | original)facultatif
masterobjectfacultatif
logoUrlstringfacultatif
colorHexstringfacultatif
faviconUrlstringfacultatif
logoTonestring (dark | light | original)facultatif
effectiveobjectfacultatif
logoUrlstringfacultatif
colorHexstringfacultatif
faviconUrlstringfacultatif
logoTonestring (dark | light | original)facultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Le service est temporairement indisponible. Réessayez l’ajout de crédits avec la même clé d’idempotence.
get/api/v1/clients/{id}/portal-brand
Votre clé API
id *
{}

Guides qui utilisent cette ressource