Create a brand profile
/v1/brand_profilesCreates the profile and its version 1. WCAG contrast is checked at save (400 contrast_validation_failed, param primary_color, with the ratio in the message). An unknown logo (another organisation's, or none) is 400 brand_asset_reference_invalid. is_default true takes the default from the organisation's previous one.
Body
Required
-
What the sender calls the profile (the portal list). Not shown to recipients.
at most 100 characters -
"Delivery from …" and the recipient page.
at most 100 characters -
Upper-cased on save. White text on it must reach 4.5:1 (rule B4).
Optional
-
is_defaultbooleanThe organisation's default: used when a delivery names no profile. Takes it from the previous default.
Defaultfalse -
sender_display_name_dativestring · nullableThe 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 · nullablebas_… from POST /brand_assets. Null or absent: the monogram is shown.
-
icon_asset_idstring · nullablebas_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 · nullableWhat 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 · nullable1–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 -
header_stylestringThe header of the recipient page and the notice e-mail:
band(the default), yourprimary_across the top with the logo on it;color letterhead, a plain header with a rule in your colour along its top;minimal, a plain header with your logo or name.One ofbandletterheadminimalDefault"band" -
supportobject · nullableThe sender's own contact, shown to the recipient on the delivery's pages.
3 fields of
support-
support.emailstring · email · nullable -
support.phonestring · nullableA telephone number, e.g. +354 440 4000.
-
support.urlstring · uri · nullablehttps:// only.
-
-
expired_messageobject · nullableYour own words on the page a recipient sees when the link has expired, per language. Plain text.
2 fields of
expired_message-
expired_message.isstring · nullableat most 500 characters -
expired_message.enstring · nullableat most 500 characters
-
-
reply_tostring · email · nullableThe notice e-mail's Reply-To address.
-
recipient_domain_idstring · nullablecdm_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 · nullablees_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 · nullableThe 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: nullresets every field.
Returns
201 application/json. Created. See the BrandProfileV1 object.
Errors have one shape; see Errors for every code.