Marca
Los colores, la fuente y el logo con los que se muestran el portal de tu organización y sus correos; lo mismo que la pestaña Marca de la configuración, con las mismas reglas. Un color es hexadecimal (
#rgb
,
#rgba
,
#rrggbb
o
#rrggbbaa
);
null
usa el del sistema de diseño de Datil. La llave necesita el alcance
settings
(o ningún alcance).
Consultar la marca#
/api/v1/brand
Bearer
La marca vigente.
logo_uploaded
dice si hay un logo subido en
/brand/logo
.
Devuelve
·
200
con la marca ·
404 not_found
si la organización no está registrada.
curl "https://edge.datil.com/api/v1/brand" \
-H "Authorization: Bearer $DATIL_API_KEY"{
"ok": true,
"brand": {
"colors": {
"primary": "#33617d",
"secondary": null,
"accent": null,
"neutral": null,
"base_100": null
},
"font_family": "Inter",
"logo_url": "/brand/logo",
"logo_uploaded": true
}
}Modificar la marca#
/api/v1/brand
Bearer
Cambia solo lo que envías;
null
borra un valor.
Content-Type: application/json
colors
objeto
primary
,
secondary
,
accent
,
neutral
y
base_100
(el fondo).
font_family
string
Nombre de una familia, hasta 60 letras, números, espacios, apóstrofos o guiones. Se usa cuando el dispositivo la tiene.
logo_url
string
URL
https://
del logo, o
/brand/logo
para volver al logo subido.
Devuelve
·
200
con la marca ·
422
con
errors
:
invalid_color:colors.primary
,
invalid_font_family:font_family
,
invalid_logo_url:logo_url
,
no_uploaded_logo:logo_url
,
unknown_field:…
.
curl -X PATCH https://edge.datil.com/api/v1/brand \
-H "Authorization: Bearer $DATIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"colors": {
"primary": "#33617d"
},
"font_family": "Inter"
}'{
"ok": true,
"brand": {
"colors": {
"primary": "#33617d",
"secondary": null,
"accent": null,
"neutral": null,
"base_100": null
},
"font_family": "Inter",
"logo_url": "/brand/logo",
"logo_uploaded": true
}
}Subir el logo#
/api/v1/brand/logo
Bearer
Guarda el logo y apunta
logo_url
a
/brand/logo
en el host de tu portal. El tipo se lee de los bytes: PNG, JPEG o WebP, hasta 500 KB.
content_base64
string
requerido
La imagen en base64.
Devuelve
·
200
con la marca ·
413 logo_too_large
·
422 not_an_image:content_base64
o
invalid_value:content_base64
.
curl -X PUT https://edge.datil.com/api/v1/brand/logo \
-H "Authorization: Bearer $DATIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content_base64": "iVBORw0KGgoAAAANSUhEUgAA…"
}'{
"ok": true,
"brand": {
"colors": {
"primary": "#33617d",
"secondary": null,
"accent": null,
"neutral": null,
"base_100": null
},
"font_family": "Inter",
"logo_url": "/brand/logo",
"logo_uploaded": true
}
}Quitar el logo subido#
/api/v1/brand/logo
Bearer
Borra el logo subido; si la marca lo mostraba, queda sin logo.
Devuelve
·
200
con la marca.
curl -X DELETE https://edge.datil.com/api/v1/brand/logo \
-H "Authorization: Bearer $DATIL_API_KEY"{
"ok": true,
"brand": {
"colors": {
"primary": "#33617d",
"secondary": null,
"accent": null,
"neutral": null,
"base_100": null
},
"font_family": "Inter",
"logo_url": null,
"logo_uploaded": false
}
}