ParasendDocs
Sign in Start free

Update a brand profile

PATCH/v1/brand_profiles/{id}

Changes a brand profile. A change to its look makes a new version; a delivery keeps the version it was sent with.

Path parameters

  • idstringrequired

    The brand profile's ID, starting bp_.

Body

Required

  • namestringrequired

    What the sender calls the profile (the portal list). Not shown to recipients.

    at most 100 characters
  • sender_display_namestringrequired

    "Delivery from …" and the recipient page.

    at most 100 characters
  • primary_colorstringrequired

    Upper-cased on save. White text on it must reach 4.5:1 (rule B4).

Optional

  • is_defaultboolean

    The organisation's default: used when a delivery names no profile. Takes it from the previous default.

    Default false
  • sender_display_name_dativestring · nullable

    The sender's name in the Icelandic dative, for “Sending frá …”. Without it the notice says “Sending frá: {name}”.

    at most 100 characters
  • logo_asset_idstring · nullable

    bas_… from POST /brand_assets. Null or absent: the monogram is shown.

  • icon_asset_idstring · nullable

    bas_… of an icon uploaded with POST /brand_assets?kind=icon. Null or left out: the tab shows a monogram on primary_color.

  • sms_sender_namestring · nullable

    What an SMS to an Icelandic number shows as its sender, once Parasend has approved the name for your company. Verified companies only. Null: PARASEND.

  • monogramstring · nullable

    1–3 letters or digits, upper-cased. Null or absent derives it from sender_display_name (first letters of its first two words, company forms such as hf./ehf. left out).

    at most 3 characters
  • The header of the recipient page and the notice e-mail: band (the default), 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
    Default "band"
  • supportobject · nullable

    The sender's own contact, shown to the recipient on the delivery's pages.

    3 fields of support
  • expired_messageobject · nullable

    Your own words on the page a recipient sees when the link has expired, per language. Plain text.

    2 fields of expired_message
  • reply_tostring · email · nullable

    The notice e-mail's Reply-To address.

  • recipient_domain_idstring · nullable

    cdm_… of your organisation's link domain, or null for Parasend's own. Changing it needs the portal and a fresh sign-in. Links use it only while it is active.

  • email_sender_idstring · nullable

    es_… of your organisation's e-mail sender, or null for Parasend's address. Changing it needs the portal and a fresh sign-in. It is used only while the sender is active; otherwise the e-mail comes from Parasend's address under your brand's name.

  • themeobject · nullable

    The finer look of the recipient page and the e-mail: colours, corners, font, layout, and what is shown. Left out or null: Parasend's own look. In an update, a field left out stays as it is and theme: null resets every field.

Returns

200 application/json. Updated. See the BrandProfileV1 object.

Errors have one shape; see Errors for every code.