PT EN

Marca

URL base: $BUSINESS_API

O objecto

namestring · obrigatório
short_namestring · obrigatório
legal_namestring · obrigatório
copyrightstring · obrigatório

Who the copyright line names (© <year> <copyright>). Empty means the legal name; when both are empty, clients show no copyright line rather than assume the product name.

supportobject · obrigatório
Mostrar atributos filhos
emailstring · obrigatório
phonestring · obrigatório
urlstring · obrigatório
linksobject · obrigatório
Mostrar atributos filhos
websitestring · obrigatório
termsstring · obrigatório
privacystring · obrigatório
colorsobject · obrigatório
Mostrar atributos filhos
brandstring · obrigatório
brand_foregroundstring · obrigatório
accentstring · obrigatório
logo_urlstring · obrigatório · anulável

Absolute path with a v hash, such as $PUBLIC_API/branding/assets/logo?v=…; null when unset

logo_dark_urlstring · obrigatório · anulável
icon_urlstring · obrigatório · anulável
updated_atstring (date-time) · obrigatório
receipt_footerstring · obrigatório
tenantobject · obrigatório
Mostrar atributos filhos
idstring · obrigatório
slugstring · obrigatório
platformobject · obrigatório
Mostrar atributos filhos
namestring · obrigatório
short_namestring · obrigatório
icon_urlstring · obrigatório · anulável
sourcesobject · obrigatório

The platform source keys plus receipt_footer.

O objecto
{
  "sources": {
    "key": "custom"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "copyright": "copyright",
  "icon_url": "https://example.org/",
  "legal_name": "Ana Matsinhe",
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "logo_dark_url": "https://example.org/",
  "logo_url": "https://example.org/",
  "name": "Ana Matsinhe",
  "platform": {
    "name": "Ana Matsinhe",
    "short_name": "Ana Matsinhe",
    "icon_url": "https://example.org/"
  },
  "receipt_footer": "receipt footer",
  "short_name": "Ana Matsinhe",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "tenant": {
    "id": "ten_2sYXpy6D7kQ3lIa31QONH8u59Ia",
    "slug": "slug"
  },
  "updated_at": "2026-11-19T09:30:00Z"
}

Obter a marca

Registos

GET /branding

The utility's effective brand and where each value comes from

Requires business:branding:read (utility owner and admin).

Devolve

200 Utility brand with sources

Mostrar atributos
namestring · obrigatório
short_namestring · obrigatório
legal_namestring · obrigatório
copyrightstring · obrigatório

Who the copyright line names (© <year> <copyright>). Empty means the legal name; when both are empty, clients show no copyright line rather than assume the product name.

supportobject · obrigatório
Mostrar atributos filhos
emailstring · obrigatório
phonestring · obrigatório
urlstring · obrigatório
linksobject · obrigatório
Mostrar atributos filhos
websitestring · obrigatório
termsstring · obrigatório
privacystring · obrigatório
colorsobject · obrigatório
Mostrar atributos filhos
brandstring · obrigatório
brand_foregroundstring · obrigatório
accentstring · obrigatório
logo_urlstring · obrigatório · anulável

Absolute path with a v hash, such as $PUBLIC_API/branding/assets/logo?v=…; null when unset

logo_dark_urlstring · obrigatório · anulável
icon_urlstring · obrigatório · anulável
updated_atstring (date-time) · obrigatório
receipt_footerstring · obrigatório
tenantobject · obrigatório
Mostrar atributos filhos
idstring · obrigatório
slugstring · obrigatório
platformobject · obrigatório
Mostrar atributos filhos
namestring · obrigatório
short_namestring · obrigatório
icon_urlstring · obrigatório · anulável
sourcesobject · obrigatório

The platform source keys plus receipt_footer.

Erros 403

Permissões business:branding:read · Funções: admin, owner

curl -X GET "$BUSINESS_API/branding" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "sources": {
    "key": "custom"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "copyright": "copyright",
  "icon_url": "https://example.org/",
  "legal_name": "Ana Matsinhe",
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "logo_dark_url": "https://example.org/",
  "logo_url": "https://example.org/",
  "name": "Ana Matsinhe",
  "platform": {
    "name": "Ana Matsinhe",
    "short_name": "Ana Matsinhe",
    "icon_url": "https://example.org/"
  },
  "receipt_footer": "receipt footer",
  "short_name": "Ana Matsinhe",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "tenant": {
    "id": "ten_2sYXpy6D7kQ3lIa31QONH8u59Ia",
    "slug": "slug"
  },
  "updated_at": "2026-11-19T09:30:00Z"
}

Actualizar a marca

Registos

PATCH /branding

Requires business:branding:write. The platform PATCH body plus receipt_footer; null resets a field to the next level down (configuration, business profile, platform). Audited as branding.updated.

Corpo application/json

namestring · opcional · anulável
short_namestring · opcional · anulável
legal_namestring · opcional · anulável
copyrightstring · opcional · anulável

Who the copyright line names; empty uses the legal name.

support_emailstring · opcional · anulável
support_phonestring · opcional · anulável
support_urlstring · opcional · anulável
website_urlstring · opcional · anulável
terms_urlstring · opcional · anulável
privacy_urlstring · opcional · anulável
colorsobject · opcional · anulável
Mostrar atributos filhos
brandstring · opcional · anulável
brand_foregroundstring · opcional · anulável
accentstring · opcional · anulável
receipt_footerstring · opcional · anulável

Devolve

200 Updated utility brand

Mostrar atributos
namestring · obrigatório
short_namestring · obrigatório
legal_namestring · obrigatório
copyrightstring · obrigatório

Who the copyright line names (© <year> <copyright>). Empty means the legal name; when both are empty, clients show no copyright line rather than assume the product name.

supportobject · obrigatório
Mostrar atributos filhos
emailstring · obrigatório
phonestring · obrigatório
urlstring · obrigatório
linksobject · obrigatório
Mostrar atributos filhos
websitestring · obrigatório
termsstring · obrigatório
privacystring · obrigatório
colorsobject · obrigatório
Mostrar atributos filhos
brandstring · obrigatório
brand_foregroundstring · obrigatório
accentstring · obrigatório
logo_urlstring · obrigatório · anulável

Absolute path with a v hash, such as $PUBLIC_API/branding/assets/logo?v=…; null when unset

logo_dark_urlstring · obrigatório · anulável
icon_urlstring · obrigatório · anulável
updated_atstring (date-time) · obrigatório
receipt_footerstring · obrigatório
tenantobject · obrigatório
Mostrar atributos filhos
idstring · obrigatório
slugstring · obrigatório
platformobject · obrigatório
Mostrar atributos filhos
namestring · obrigatório
short_namestring · obrigatório
icon_urlstring · obrigatório · anulável
sourcesobject · obrigatório

The platform source keys plus receipt_footer.

Erros 400 · 403

Permissões business:branding:write · Funções: admin, owner

curl -X PATCH "$BUSINESS_API/branding" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Ana Matsinhe",
  "short_name": "Ana Matsinhe",
  "legal_name": "Ana Matsinhe",
  "copyright": "copyright",
  "support_email": "ana.matsinhe@example.org",
  "support_phone": "+258841234567",
  "support_url": "https://example.org/",
  "website_url": "https://example.org/",
  "terms_url": "https://example.org/",
  "privacy_url": "https://example.org/",
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "receipt_footer": "receipt footer"
}'
Resposta 200
{
  "sources": {
    "key": "custom"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "copyright": "copyright",
  "icon_url": "https://example.org/",
  "legal_name": "Ana Matsinhe",
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "logo_dark_url": "https://example.org/",
  "logo_url": "https://example.org/",
  "name": "Ana Matsinhe",
  "platform": {
    "name": "Ana Matsinhe",
    "short_name": "Ana Matsinhe",
    "icon_url": "https://example.org/"
  },
  "receipt_footer": "receipt footer",
  "short_name": "Ana Matsinhe",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "tenant": {
    "id": "ten_2sYXpy6D7kQ3lIa31QONH8u59Ia",
    "slug": "slug"
  },
  "updated_at": "2026-11-19T09:30:00Z"
}

Carregar um ficheiro da marca

Registos

PUT /branding/assets/{kind}

Requires business:branding:write. Same types, size cap and SVG sanitising as the platform upload. Audited as branding.asset_uploaded.

Parâmetros

kindstring · caminho · obrigatório

Which brand file to replace: logo, logo_dark or icon; any other value answers 404.

um de logo, logo_dark, icon

Devolve

200 Updated utility brand

Mostrar atributos
namestring · obrigatório
short_namestring · obrigatório
legal_namestring · obrigatório
copyrightstring · obrigatório

Who the copyright line names (© <year> <copyright>). Empty means the legal name; when both are empty, clients show no copyright line rather than assume the product name.

supportobject · obrigatório
Mostrar atributos filhos
emailstring · obrigatório
phonestring · obrigatório
urlstring · obrigatório
linksobject · obrigatório
Mostrar atributos filhos
websitestring · obrigatório
termsstring · obrigatório
privacystring · obrigatório
colorsobject · obrigatório
Mostrar atributos filhos
brandstring · obrigatório
brand_foregroundstring · obrigatório
accentstring · obrigatório
logo_urlstring · obrigatório · anulável

Absolute path with a v hash, such as $PUBLIC_API/branding/assets/logo?v=…; null when unset

logo_dark_urlstring · obrigatório · anulável
icon_urlstring · obrigatório · anulável
updated_atstring (date-time) · obrigatório
receipt_footerstring · obrigatório
tenantobject · obrigatório
Mostrar atributos filhos
idstring · obrigatório
slugstring · obrigatório
platformobject · obrigatório
Mostrar atributos filhos
namestring · obrigatório
short_namestring · obrigatório
icon_urlstring · obrigatório · anulável
sourcesobject · obrigatório

The platform source keys plus receipt_footer.

Erros 400 · 403

Permissões business:branding:write · Funções: admin, owner

curl -X PUT "$BUSINESS_API/branding/assets/{kind}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "sources": {
    "key": "custom"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "copyright": "copyright",
  "icon_url": "https://example.org/",
  "legal_name": "Ana Matsinhe",
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "logo_dark_url": "https://example.org/",
  "logo_url": "https://example.org/",
  "name": "Ana Matsinhe",
  "platform": {
    "name": "Ana Matsinhe",
    "short_name": "Ana Matsinhe",
    "icon_url": "https://example.org/"
  },
  "receipt_footer": "receipt footer",
  "short_name": "Ana Matsinhe",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "tenant": {
    "id": "ten_2sYXpy6D7kQ3lIa31QONH8u59Ia",
    "slug": "slug"
  },
  "updated_at": "2026-11-19T09:30:00Z"
}

Remover um ficheiro da marca

Registos

DELETE /branding/assets/{kind}

Requires business:branding:write. Audited as branding.asset_removed.

Parâmetros

kindstring · caminho · obrigatório

Which brand file to remove: logo, logo_dark or icon; any other value answers 404.

um de logo, logo_dark, icon

Devolve

200 Updated utility brand

Mostrar atributos
namestring · obrigatório
short_namestring · obrigatório
legal_namestring · obrigatório
copyrightstring · obrigatório

Who the copyright line names (© <year> <copyright>). Empty means the legal name; when both are empty, clients show no copyright line rather than assume the product name.

supportobject · obrigatório
Mostrar atributos filhos
emailstring · obrigatório
phonestring · obrigatório
urlstring · obrigatório
linksobject · obrigatório
Mostrar atributos filhos
websitestring · obrigatório
termsstring · obrigatório
privacystring · obrigatório
colorsobject · obrigatório
Mostrar atributos filhos
brandstring · obrigatório
brand_foregroundstring · obrigatório
accentstring · obrigatório
logo_urlstring · obrigatório · anulável

Absolute path with a v hash, such as $PUBLIC_API/branding/assets/logo?v=…; null when unset

logo_dark_urlstring · obrigatório · anulável
icon_urlstring · obrigatório · anulável
updated_atstring (date-time) · obrigatório
receipt_footerstring · obrigatório
tenantobject · obrigatório
Mostrar atributos filhos
idstring · obrigatório
slugstring · obrigatório
platformobject · obrigatório
Mostrar atributos filhos
namestring · obrigatório
short_namestring · obrigatório
icon_urlstring · obrigatório · anulável
sourcesobject · obrigatório

The platform source keys plus receipt_footer.

Erros 403

Permissões business:branding:write · Funções: admin, owner

curl -X DELETE "$BUSINESS_API/branding/assets/{kind}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "sources": {
    "key": "custom"
  },
  "colors": {
    "brand": "brand",
    "brand_foreground": "brand foreground",
    "accent": "accent"
  },
  "copyright": "copyright",
  "icon_url": "https://example.org/",
  "legal_name": "Ana Matsinhe",
  "links": {
    "website": "website",
    "terms": "terms",
    "privacy": "privacy"
  },
  "logo_dark_url": "https://example.org/",
  "logo_url": "https://example.org/",
  "name": "Ana Matsinhe",
  "platform": {
    "name": "Ana Matsinhe",
    "short_name": "Ana Matsinhe",
    "icon_url": "https://example.org/"
  },
  "receipt_footer": "receipt footer",
  "short_name": "Ana Matsinhe",
  "support": {
    "email": "ana.matsinhe@example.org",
    "phone": "+258841234567",
    "url": "https://example.org/"
  },
  "tenant": {
    "id": "ten_2sYXpy6D7kQ3lIa31QONH8u59Ia",
    "slug": "slug"
  },
  "updated_at": "2026-11-19T09:30:00Z"
}