Brand profiles

Endpoints

• POSTCreate a brand profile/v1/brand_profiles
• GETList brand profiles/v1/brand_profiles
• GETRetrieve a brand profile/v1/brand_profiles/{id}
• PATCHUpdate a brand profile/v1/brand_profiles/{id}
• DELDelete a brand profile/v1/brand_profiles/{id}
• GETList a brand profile's versions/v1/brand_profiles/{id}/versions
• POSTPreview a brand profile/v1/brand_profiles/preview

The BrandProfileV1 object

• sender_display_namestringrequired

  Your name as recipients see it, in the notice ("Delivery from …") and on the recipient page.

• sender_display_name_dativestring · nullablerequired

  Your name in the Icelandic dative case, for Icelandic notices ("Sending frá …"). null when not set; the notice then says "Sending frá:" followed by sender_display_name.

• logoobject · nullablerequired

  The logo: its asset ID (bas_…), the path of its PNG, the PNG's SHA-256, and its size in CSS pixels. null when there is no logo; the monogram is shown instead.

• monogramstringrequired

  1–3 upper-case letters or digits shown where there is no logo. Unless you set it, the first letters of the first two words of sender_display_name, leaving out company forms such as hf. and ehf.

• primary_colorstringrequired

  Your brand colour, #RRGGBB in upper case: the header band, links, and the buttons unless theme.colors.button_background sets their own.

• contrast_rationumberrequired

  The button text (white unless theme.colors.button_text) on primary_color, two decimals, rounded down.

  at least 4.5, at most 21
• header_stylestringrequired

  The header of the recipient page and the notice e-mail: band, your primary_color across the top with the logo on it; letterhead, a plain header with a rule in your colour along its top; minimal, a plain header with your logo or name.

  One of band letterhead minimal
• supportobjectrequired

  Your own contact for recipients, in the support line of the recipient page: email, phone and url, each null when not set.

  3 fields of support

  • support.emailstring · nullable
  • support.phonestring · nullable
  • support.urlstring · nullable
• expired_messageobjectrequired

  Your own words on the page a recipient sees when their link has expired, in Icelandic (is) and English (en). Plain text; each null when not set.

  2 fields of expired_message

  • expired_message.isstring · nullable
  • expired_message.enstring · nullable
• reply_tostring · nullablerequired

  The Reply-To address of the e-mails sent to recipients (the notice and reminders), so replies come to you. null: no Reply-To.

• idstringrequired

  The brand profile's ID, starting bp_.

• objectstringrequired

  Always brand_profile.

• namestringrequired

  Your name for the profile, 1–100 characters. Recipients never see it.

• is_defaultbooleanrequired

  Whether this is your organisation's default profile, used for any delivery that names none (directly or through its batch). Only one profile is the default.

• versionintegerrequired

  The current version's number.

  at least 1
• version_idstringrequired

  bpv_…: the version a delivery created now would use.

• used_byobjectrequired

  How much the profile is used: deliveries, the number of deliveries sent with one of its versions.

  1 field of used_by

  • used_by.deliveriesintegerrequired

    Deliveries that froze one of its versions (a count; names none).

    at least 0
• created_atstring · date-timerequired

  When the profile was created, in ISO 8601 (UTC).

• updated_atstring · date-timerequired

  When the profile last changed (renamed, made or no longer the default, given a new version, or archived), in ISO 8601 (UTC).

• archived_atstring · date-time · nullablerequired

  When the profile was archived with DELETE /brand_profiles/{id}, in ISO 8601 (UTC); null while it is in use. Deliveries already sent with it keep its look.

• sms_sender_nameobject · nullable

  The SMS sender name and Parasend's answer to it, or null (PARASEND).

  4 fields of sms_sender_name

  • sms_sender_name.namestringrequired
  • sms_sender_name.statestringrequired
    One of pending approved rejected
  • sms_sender_name.readybooleanrequired

    Approved and set up: SMS to Icelandic numbers show it.

  • sms_sender_name.reasonstring · nullablerequired

    Why Parasend did not approve it.

• iconobject · nullable

  The tab icon, or null.

  4 fields of icon

  • icon.asset_idstring

    The brand asset's ID, starting bas_.

  • icon.urlstring

    The 180 px PNG (/brand_assets/{id}/content).

  • icon.small_urlstring

    The 32 px PNG (?size=small).

  • icon.sha256string

    Of the 180 px PNG.

• recipient_domain_idstring · nullable

  The link domain (cdm_…), or null.

• email_sender_idstring · nullable

  The e-mail sender (es_…), or null.

• themeobject

  The look a version sets. Every field may be null (Parasend's own) and, in a PATCH, left out (unchanged); theme: null resets every field. Checked when saved: every text and background pair must reach a contrast of 4.5:1. No CSS.

  17 fields of theme

  • theme.colorsobject · nullable

    Colours of the recipient page, each #RRGGBB or null for Parasend's default; button_background and button_text colour the e-mail's button too. In an update, colors: null resets them all.

    9 fields of colors

    • theme.colors.page_backgroundstring · nullable

      Default #F5F6FA.

    • theme.colors.card_backgroundstring · nullable

      Default #FFFFFF.

    • theme.colors.textstring · nullable

      Default #0E1526.

    • theme.colors.secondary_textstring · nullable

      Default #5B6472.

    • theme.colors.button_backgroundstring · nullable

      The buttons' colour, on the page and in the e-mail. Default primary_color.

    • theme.colors.button_textstring · nullable

      Default #FFFFFF.

    • theme.colors.header_backgroundstring · nullable
    • theme.colors.header_textstring · nullable
    • theme.colors.dividerstring · nullable

      Default #E6E9F2.

  • theme.button_radiusinteger · nullable

    Default 12.

    at least 0, at most 24
  • theme.card_radiusinteger · nullable

    Default 14.

    at least 0, at most 24
  • theme.card_shadowboolean · nullable

    Default true.

  • theme.fontstring · nullable

    The font, served by the recipient page. Default inter.

    One of inter system source_sans source_serif
  • theme.logo_heightinteger · nullable

    CSS px. Default the header style's own.

    at least 20, at most 48
  • theme.header_alignstring · nullable

    Default left.

    One of left center
  • theme.show_safety_noteboolean · nullable

    The note “Er þetta öruggt?” (Is this safe?) on the page and in the e-mail. Default true.

  • theme.show_support_lineboolean · nullable

    Default true.

  • theme.show_sender_lineboolean · nullable

    The “Sendandi:” (Sender:) line. The page leaves it out only where the header names the sender in words; false always leaves it out of the e-mail's footer. Default true.

  • theme.card_footerstring · nullable

    default: the date; custom: the sender's words and the date; hidden: none. custom needs card_footer_text.

    One of default custom hidden
  • theme.card_footer_textobject · nullable

    Your own words for the card's footer when card_footer is custom, in Icelandic (is) and English (en): plain text, up to 200 characters each. custom needs at least one of them.

    2 fields of card_footer_text

    • theme.card_footer_text.isstring · nullable
      at most 200 characters
    • theme.card_footer_text.enstring · nullable
      at most 200 characters
  • theme.layoutstring · nullable

    The page layout. Default card; every other layout needs page_image_asset_id.

    One of card split banner backdrop
  • theme.page_image_asset_idstring · nullable

    bas_… of a photo uploaded with POST /brand_assets?kind=image.

  • theme.logo_backgroundstring · nullable

    The header's logo on a white tile (tile, or null) or straight on the colour (none). Not set with a new logo: none for a transparent logo, tile otherwise.

    One of tile none
  • theme.show_service_labelboolean · nullable

    The label above the e-mail's headline that names the service (“Electronic registered delivery” in English). null is on. The e-mail only.

  • theme.show_name_with_logoboolean · nullable

    The sender's name beside the logo in the header, in every header style. null is off.

• contrastsobject

  The contrast ratio of every colour pair when saved, rounded down to two decimals: button_text_on_primary (the button text on the button's colour), links_on_card, text_on_card, secondary_text_on_card, header_text_on_header, and logo_on_header for a logo straight on the band (a warning below 3, never a refusal).