v1Recursos/Clients/getConsultar la marca del portal del cliente

Consultar la marca del portal del cliente

Consultar o reemplazar el logotipo, color, favicon y tono del portal como un conjunto completo. customized=false borra las excepciones y hereda los valores de la agencia. Se requiere un usuario identificado con acceso a Clientes y a este cliente; también se aplican las restricciones de la credencial.

get/api/v1/clients/{id}/portal-brand
clients:read
Parámetros de consulta
idstringobligatorio
Respuesta
dataobjectobligatorio
customizedbooleanopcional
overrideobjectopcional
logoUrlstringopcional
colorHexstringopcional
faviconUrlstringopcional
logoTonestring (dark | light | original)opcional
masterobjectopcional
logoUrlstringopcional
colorHexstringopcional
faviconUrlstringopcional
logoTonestring (dark | light | original)opcional
effectiveobjectopcional
logoUrlstringopcional
colorHexstringopcional
faviconUrlstringopcional
logoTonestring (dark | light | original)opcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
503El servicio no está disponible temporalmente. Reintente la asignación de créditos con la misma clave de idempotencia.
get/api/v1/clients/{id}/portal-brand
Su clave de API
id *
{}

Guías que usan este recurso