Skip to main content

​
Connect page branding (white-label)

The public connect page (/connect/{token}) — where your end customer scans the QR code or runs Meta Embedded Signup to connect a WhatsApp number (see Remote Pairing) — can be branded per tenant. Your customers see your brand instead of “Pilot Status”.

​
What you can customize

FieldTypeNotes
logoUrlhttps URLShown in the header instead of the company name.
primaryColorhex #RRGGBBButtons, accents, highlights.
backgroundColorhex #RRGGBBPage/card background.
companyNamestring (≤ 60)Header title (replaces “Pilot Status”).
subtitlestring (≤ 120)Header subtitle (replaces “Conexão WhatsApp”).
supportUrlhttps URLRenders a “Need help?” link.
defaultRedirectUrlhttps URLWhere to send the user after a successful connection.
hidePilotStatusBrandingbooleanWhite-label: hides the “Pilot Status” footer.
Colors are stored as hex and converted to the page’s theme automatically.

​
Four ways to configure it

Resolution precedence (highest → lowest): 
URL query param  >  per-link override  >  tenant branding (dashboard/API)  >  Pilot Status default
Profile → Marca: upload a logo, pick colors, set the title/subtitle/support link, toggle white-label, and see a live preview. This branding applies to all of the tenant’s connect links.

​
2) Public API — GET / PUT /v1/branding

Requires a tenant-scoped API key. Number-scoped keys get 403 (NUMBER_SCOPE_NOT_ALLOWED).
curl "https://pilotstatus.com.br/v1/branding" \
  -H "x-api-key: ps_your_tenant_scoped_key"
Response (both): 
HTTP 200
{ "branding": { "companyName": "Acme", "primaryColor": "#1fd286", "hidePilotStatusBranding": true, "logoUrl": null, "backgroundColor": null, "subtitle": null, "supportUrl": null, "defaultRedirectUrl": null } }
All PUT fields are optional — send null to clear a field, omit a key to leave it unchanged. Logo upload (dashboard session): POST /api/branding/logo accepts a multipart file (PNG / JPG / WebP, ≤ 2 MB) and returns { url, key, mimeType, fileName, sizeBytes }. Use the returned url as logoUrl in PUT /v1/branding. When you create a pairing link, pass a branding object to override branding for just that link (it is snapshotted onto the token and overrides the saved tenant branding): 
curl -X POST "https://pilotstatus.com.br/v1/numbers/remote-pairing" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ps_your_token_here" \
  -d '{
    "name": "Customer João",
    "number": "+5511999999999",
    "branding": { "companyName": "Customer João Co.", "primaryColor": "#2563eb" }
  }'

​
4) URL query params (cosmetic only)

Append whitelisted, sanitized params to a connect link to tweak appearance on the fly. These are cosmetic only — they never change which tenant/number is paired: 
/connect/{token}?primary=%231fd286&title=Acme&hideBranding=1
Supported: logo (https), primary (hex), bg (hex), title, subtitle, support (https), hideBranding (1/true).

​
Public branding endpoint

The connect page reads its branding from:
  • GET /v1/remote-pairing/{token} → includes a resolved branding object, or
  • GET /v1/connect/{token}/branding → { branding } (used by the Meta Embedded Signup flow; always 200, falling back to Pilot Status defaults for an unknown token).

​
Notes

  • Branding is per tenant; a single saved branding applies to every connect link, with optional per-link and query-param overrides on top.
  • hidePilotStatusBranding: true removes the Pilot Status attribution (white-label). Use it to present the connection flow fully under your own brand.
  • Query-param overrides are intentionally limited to appearance; the token still gates the actual pairing.