Skip to content
Pidgely Docs

API reference · Templates

Dismiss the automatic brand import

POSThttps://api.pidgely.com/brand/auto-import/dismiss
View as Markdown

Every plan. Hides the notice of the latest automatic import. When its brand is still the unreviewed theme (state: "auto"), it is kept as reviewed and state becomes saved; the theme itself does not change. Returns the brand.

Every plan. Full access API keys. Hides the notice of the latest automatic import. When its brand is still the unreviewed organization theme (state auto), the brand is kept as reviewed (state becomes saved). Returns the brand.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X POST 'https://api.pidgely.com/brand/auto-import/dismiss' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "brand",
  "state": "none",
  "theme": {
    "brand_color": "brand_color",
    "text_color": "text_color",
    "background_color": "background_color",
    "content_color": "content_color",
    "link_color": "link_color",
    "font": "system",
    "content_width": 480,
    "radius": 0,
    "logo_url": "logo_url",
    "logo_width": 1,
    "logo_alt": "logo_alt",
    "logo_align": "left",
    "logo_dark_url": "logo_dark_url",
    "button_text_color": "button_text_color",
    "web_font": "web_font",
    "heading_font": "system",
    "heading_web_font": "heading_web_font"
  },
  "theme_saved": false,
  "brand": {
    "name": "Example",
    "website": "website",
    "address": "address",
    "socials": [
      {
        "network": "x",
        "url": "https://acme.com/webhooks/pidgely"
      }
    ],
    "imported_from": "imported_from"
  },
  "brand_saved": false,
  "suggested_website": "suggested_website",
  "brand_import": false,
  "auto_import": null
}

Response fields

Name Type Required Description
object string Yes Object type. One of brand.
state string Yes none: no theme saved; auto: applied by the automatic import, waiting for a review; saved: saved or confirmed by a user. One of none, auto, saved.
theme object Yes Global look of a builder e-mail. Colors are hex (#rrggbb).
theme.brand_color string No —
theme.text_color string No —
theme.background_color string No —
theme.content_color string No Background of the content card.
theme.link_color string No —
theme.font string No One of system, inter, helvetica, georgia, verdana, trebuchet.
theme.content_width integer No Between 480 and 800.
theme.radius integer No Between 0 and 32.
theme.logo_url string No —
theme.logo_width integer No —
theme.logo_alt string No —
theme.logo_align string No One of left, center, right.
theme.logo_dark_url string No Logo variant shown in dark mode by clients that support it (Apple Mail, iOS); others keep logo_url.
theme.button_text_color string No Label color of buttons on the brand color; empty picks white or near-black automatically.
theme.web_font string No Google Fonts family loaded where e-mail clients support web fonts; font is the fallback stack.
theme.heading_font string No Heading stack (empty = font). One of system, inter, helvetica, georgia, verdana, trebuchet.
theme.heading_web_font string No Google Fonts family for headings (empty = web_font).
theme_saved boolean Yes —
brand object Yes The organization's identity used by AI assist (sender name, links, footer) and the brand import.
brand.name string No Display name.
brand.website string No —
brand.address string No Postal address shown in footers.
brand.socials object[] No —
brand.socials[].network string Yes One of x, linkedin, instagram, facebook, youtube, github, tiktok, discord, website.
brand.socials[].url string Yes Public https URL that receives the events.
brand.imported_from string No Page the brand was imported from.
brand_saved boolean Yes —
suggested_website string Yes Website to prefill in "Import brand from website" (saved website, else the parent of a verified domain, else the domain of the automatic import); empty when none.
brand_import boolean Yes Brand import is configured on the server.
auto_import object | null Yes The latest automatic import, or null.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.
404 not_found The organization has no automatic import.