Preview a brand profile

POST/v1/brand_profiles/preview

Shows a draft brand profile as it would be sent and seen, with a sample delivery that says it is one: the notice e-mail and the recipient page's content. Every field is checked as POST /brand_profiles checks it, with the same errors, except that colours that fail the contrast check are drawn anyway and the refusal a save would give is in contrast_error. Logos and photos must be your organisation's and of the right kind (400 brand_asset_reference_invalid). No Idempotency-Key is needed.

Query parameters

localestring

The sample delivery's language, which sets the language of the e-mail and the page.
One of is en
Default "is"

Body

Returns

200 application/json. The draft, drawn.

Errors have one shape; see Errors for every code.

Code language

Request

curl -X POST "https://api.parasend.com/v1/brand_profiles/preview" \
  -H "Authorization: Bearer $PARASEND_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_display_name": "Fyrirtæki ehf.",
    "primary_color": "#1E5BB8"
  }'

const res = await fetch('https://api.parasend.com/v1/brand_profiles/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PARASEND_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    sender_display_name: 'Fyrirtæki ehf.',
    primary_color: '#1E5BB8',
  }),
});
const data = await res.json();

import os, requests, uuid

res = requests.post(
    "https://api.parasend.com/v1/brand_profiles/preview",
    headers={
        "Authorization": f"Bearer {os.environ['PARASEND_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "sender_display_name": "Fyrirtæki ehf.",
        "primary_color": "#1E5BB8",
    },
)
data = res.json()

using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.parasend.com/v1/brand_profiles/preview");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PARASEND_KEY"));
request.Headers.Add("Idempotency-Key", Guid.NewGuid().ToString());
request.Content = new StringContent("""
{
  "sender_display_name": "Fyrirtæki ehf.",
  "primary_color": "#1E5BB8"
}
""", Encoding.UTF8, "application/json");
var response = await http.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

var json = """
    {
      "sender_display_name": "Fyrirtæki ehf.",
      "primary_color": "#1E5BB8"
    }
    """;
var request = HttpRequest.newBuilder(URI.create("https://api.parasend.com/v1/brand_profiles/preview"))
    .header("Authorization", "Bearer " + System.getenv("PARASEND_KEY"))
    .header("Idempotency-Key", UUID.randomUUID().toString())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(json))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.parasend.com/v1/brand_profiles/preview', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('PARASEND_KEY'),
        'Idempotency-Key' => bin2hex(random_bytes(16)),
    ],
    'json' => [
        'sender_display_name' => 'Fyrirtæki ehf.',
        'primary_color' => '#1E5BB8',
    ],
]);
$data = json_decode($response->getBody(), true);

Response · 200

{
  "object": "brand_profile_preview",
  "locale": "is",
  "contrasts": {
    "button_text_on_primary": 6.47,
    "links_on_card": 6.47,
    "text_on_card": 18.19,
    "secondary_text_on_card": 5.98,
    "header_text_on_header": 6.47
  },
  "contrast_error": null,
  "email": {
    "template": "invitation.email",
    "version": 29,
    "from_name": "Sending frá: Fyrirtæki ehf.",
    "subject": "Sýnishorn af sendingu",
    "html": "<!doctype html><html lang=\"is\"><head><meta charset=\"utf-8\"><meta name=\"viewport\" content=\"width=device-width,initial-scale=1\"><meta name=\"color-scheme\" content=\"light\"><title>Sýnishorn af sendingu</title></head><body style=\"margin:0;padding:0;background:#F5F6FA;\"><div style=\"display:none;max-height:0;overflow:hidden;\">Opnaðu sendinguna og staðfestu móttöku. Aðgengileg til 20. nóvember 2026.</div><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"background:#F5F6FA;\"><tr><td align=\"center\" style=\"padding:20px 12px;\"><table role=\"presentation\" width=\"600\" cellpadding=\"0\" cellspacing=\"0\" style=\"width:100%;max-width:600px;\"><tr><td style=\"background:#FFFFFF;border:1px solid #E6E9F2;border-radius:12px;\"><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\"><tr><td bgcolor=\"#1E5BB8\" style=\"background:#1E5BB8;border-radius:12px 12px 0 0;padding:16px 28px;\"><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\"><tr><td width=\"34\" height=\"34\" align=\"center\" valign=\"middle\" bgcolor=\"#FFFFFF\" style=\"width:34px;height:34px;background:#FFFFFF;border-radius:8px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:13px;font-weight:700;letter-spacing:0.02em;color:#1E5BB8;text-align:center;vertical-align:middle;\">F</td><td style=\"padding-left:10px;vertical-align:middle;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:17px;font-weight:600;letter-spacing:-0.01em;line-height:1.25;color:#FFFFFF;\">Fyrirtæki ehf.</td></tr></table></td></tr><tr><td style=\"padding:32px 36px 28px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;color:#0E1526;\"><p style=\"margin:0;font-size:13px;font-weight:600;color:#147A52;\">Rekjanleg rafræn afhendingarþjónusta</p><h1 style=\"margin:8px 0 20px;font-size:24px;line-height:1.3;font-weight:700;color:#0E1526;\">Fyrirtæki ehf. hefur sent þér 1 skjal með Parasend</h1><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"border:1px solid #E6E9F2;border-radius:12px;\"><tr><td style=\"padding:14px 16px;\"><p style=\"margin:0;font-size:16px;font-weight:600;\">Sýnishorn af sendingu</p><p style=\"margin:0;font-size:14px;color:#5B6472;padding-top:4px;\">1 skjal · aðgengilegt til 20. nóvember 2026</p></td></tr></table><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"margin-top:16px;background:#EEF0F7;border-radius:12px;\"><tr><td style=\"padding:14px 16px;\"><p style=\"margin:0;font-size:12px;font-weight:600;color:#5B6472;\">Skilaboð frá sendanda</p><p style=\"margin:0;font-size:15px;line-height:1.55;color:#202C49;padding-top:4px;\">Þetta er sýnishorn. Svona birtist sendingin viðtakanda.</p></td></tr></table><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"margin-top:22px;\"><tr><td align=\"center\" bgcolor=\"#1E5BB8\" style=\"background:#1E5BB8;border-radius:12px;\"><a href=\"https://parasend.com/d/synishorn\" style=\"display:block;padding:15px 20px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:16px;font-weight:600;color:#FFFFFF;text-decoration:none;\">Opna sendinguna</a></td></tr></table><p style=\"margin:0;font-size:14px;color:#5B6472;text-align:center;padding-top:10px;\">Þú staðfestir móttöku með rafrænum skilríkjum. Það tekur innan við mínútu.</p><p style=\"margin:0;font-size:13px;line-height:1.6;color:#5B6472;padding-top:20px;\">Virkar hnappurinn ekki? Opnaðu þennan hlekk í vafra:<br><a href=\"https://parasend.com/d/synishorn\" style=\"color:#1E5BB8;word-break:break-all;\">https://parasend.com/d/synishorn</a></p></td></tr></table></td></tr><tr><td style=\"height:16px;line-height:16px;font-size:0;\">&nbsp;</td></tr><tr><td style=\"background:#ECEEF4;border-radius:12px;padding:18px 24px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:13px;line-height:1.6;color:#5B6472;\"><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\"><tr><td style=\"padding:1px 12px 0 0;vertical-align:top;\"><img src=\"cid:safety-shield-v1\" width=\"20\" height=\"20\" alt=\"\" style=\"display:block;border:0;width:20px;height:20px;max-width:20px;\"></td><td style=\"vertical-align:top;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:13px;line-height:1.6;color:#5B6472;\"><b style=\"color:#202C49;\">Er þetta öruggt?</b> Parasend biður þig aldrei um lykilorð eða kortaupplýsingar. Móttaka sendingarinnar er skráð.</td></tr></table><p lang=\"en\" style=\"margin:0;padding:12px 0 0 32px;\">In English: Fyrirtæki ehf. has sent you 1 document through Parasend, an electronic registered delivery service. Open the delivery with the button above and confirm receipt.</p></td></tr><tr><td style=\"padding:16px 12px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:12px;line-height:1.6;color:#5B6472;text-align:center;\">Þessi tilkynning er frá Parasend. Sendandi: Fyrirtæki ehf.<br>Parasend er rekjanleg rafræn afhendingarþjónusta sem Justikal ehf. rekur, Akralind 3, 201 Kópavogi.<br><a href=\"https://parasend.com/legal/privacy\" style=\"color:#5B6472;text-decoration:underline;\">Persónuvernd</a></td></tr></table></td></tr></table></body></html>",
    "text": "Fyrirtæki ehf. hefur sent þér 1 skjal með Parasend.\n\nSýnishorn af sendingu\n1 skjal · aðgengilegt til 20. nóvember 2026\n\nSkilaboð frá sendanda:\nÞetta er sýnishorn. Svona birtist sendingin viðtakanda.\n\nOpna sendinguna: https://parasend.com/d/synishorn\nÞú staðfestir móttöku með rafrænum skilríkjum. Það tekur innan við mínútu.\n\nEr þetta öruggt? Parasend biður þig aldrei um lykilorð eða kortaupplýsingar. Móttaka sendingarinnar er skráð.\n\nIn English: Fyrirtæki ehf. has sent you 1 document through Parasend, an electronic registered delivery service. Open the delivery with the button above and confirm receipt.\n\n—\nÞessi tilkynning er frá Parasend. Sendandi: Fyrirtæki ehf.\nParasend er rekjanleg rafræn afhendingarþjónusta sem Justikal ehf. rekur, Akralind 3, 201 Kópavogi.\n",
    "images": {
      "safety-shield-v1": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAGtUlEQVR4nOyaa2wUVRTHz5nZbWlBaXeLH9SofNGCkIghwUBbSsQHBsEulgRIBGLkER4GY4C2aBpDu1RD0FZFwAh8ICoru1SJxoTE2hYwKlEjLxsQX0SM+0Ab2C3dudczC8Wd2e32zuzMQkp/X2b3zn2c/9xzz8x9OOAmwwE3GUOCBztDgu2muGZ2uQzyQvW3AsruiLe1A3IIQi5YNSPfNWLYfAlwFbU4QXOPw3ccoTnUHX0fWj7rAZuxVXDJ2lm3c1leQT+XI2Jxpryc8whdtsbijpaLr/nOg03YIri4rqpM5rCaA1QhoKFhw4HHySi/gtASaQh0gsVYKthVU7UYEV4gkePAAkj8MTJxc6jRvwssImvBfW5LQpdQdSWZc/Mg57BdddsC7JHMlMvW3U0LNuS2mQJTpoCWUk327m5MsHHjAmRcs6hxlj3EDAgLdq2bc78k80/o5+jMOcn9AHcAXn4r1HDgHJjAXTfzDuB5KxD4cwO7O5wFKT4juPHjn0AAYcHuWs9Oyryo3wx2vE9FPYrzHUFvYAkIIPzKQM5HA6Z7PnyvwrE54vUfAquhBxcG2Em/dhbVeSocnK8kS6rT5LwXBDH9aUlR8xRIl6ebdVujXGjwt9OlPeHuLO8gPftSMIEEJqHx9VeuxCajtqm2DSYZmi0NdoYED3ZuOMHF62beJaFjFpd5a7ih9XewGNNR2g6Ka6vGyVLetyhJLRKTj7rWeu4Ei7lhBJdsmHWfDPAFve9GJRLoKslQDxZzQ7i0KhaY3Cnw3Zw1172H1UkJV+RDerG05BNiynXsYZqyKbov6X4flmjgcdXMHovAvqT1Lreusb85k6aFX933Rz9FJdDZBoKI9zDiP7pGitJlU8VqAg/1YLp8ajqC1K4Xm+hZhtPCTfuOQz/QrEy/IHgBBBEWjBzC2gR0pa1Qcr6iDTysLTFGk1D/q+kpPUtzaZSVKZnEXqkW3Lr/IRBEWDBDrhFMD8AlVpLGJgWkPtH9BygeBEkpE5nI0wKD1itQ1xkZEO9hwIguoUCdoOvzcYm9RO6uM4DEKY4OV43nafWaIpbGLONsqojYUfXVI6hH87Sm2NDDHFmXPq3olvwx+jQ1SHEFK64urCdbNUpC8F1z9/9rDoIcLw97W0+AACymjEm1DbpAEGHBvQzbUgpzqTJdXnUMMsam0kJexmBy5dUjVYquR6mgxCv1ab1Oh/D+lLDgbm8gRK76q6ZxTG28j0hT649MYRWp7n0V9dUDrGKgAJVaDit1CWf+rfdZP4ZVaF3rsPY/PA71Txb2l18Vnda9DbpxH7TofwuVfVhTE8fDRuowJJgjHtEkIOa7Y85Fmcok3Buhgizrumphl1E3vta+LC9W29SmsiNgAGOC4xAgF2WaROTLBioXaQwcC+Y7xgNj89WrYTfua0pdrk22hyzq6cV9YADDWy20Pv0RFZqjaRjZpFDD/q/BRoprPFNkBN0OBv8g2BiYBwYwPHlAxt5MTcMmsBkS26hPYxyawSCGBQc37W+jIKQNNoiVJeurFoBNkFctokuFNpV/H/YGDI1fFXPTQ47PpybBG8XrqkeCxdxaX+2iwfq6Pp12O1aCCUwJDm3yH6Re3p2cpk4EJDnuoxmsdXNsqsvZo3xIuwzaB0l7SWa3dkwbx/Njq0G3A0BR9BF3T9W7YBFU13skdrqmXYBzwd6La8AkMpgk2na6J7+89Djt7GnGLvX0hIKyMdFo58msNtfcNZ4NVFeKMJopzY02HTgJJjEtWCXWcer0sLLSbjLsMe0dPn14xVi81HGyDYyDFKQaqWdf1t+gqLwm7PXvgSyw5FAL9cbbZOByfTp9GLSGoo55sMUXFaroxUeHlzhH7CWrnkhzd3uw0b8UssSqUzzUK1Wfq2M45Q6H0zRHXjDQh4mrbvZkZNIe8pZ70tTxadDrn5n4lSVZuXQy0QdG7y3Md9CqBmrXsFBdGcFnh5eXFl2aOL4dvjoR19xfU13gnla6BTm+k/7wGvcFQ7/NhaN/Ci/UZcLyg2nU03XU0xvT3uRwngHfehkcW6E3jsOcoJ7SW0aR7raUrARdakPewCawEFtO4pWsf6qSS9IuqvxuMMdZhSsL7Th4aplLJ3Op89Qv0YnjthU6WSG9Riah4IOlPlUo+G0Jdkc9sc0HfgYbsP00ravO85DE6KsMMePBk8SZEQ7P0FfcN2AjuTk+XF/pcMVcc1CC1dTgZO1N3skYNIfPOPzg81kSmDKRG8FJjKz1POgEWKq6r8L4tgtNgR8gh+Rc8PVm6MjDYGdI8GDnPwAAAP//Q/PBygAAAAZJREFUAwBNHsTsz47Z7QAAAABJRU5ErkJggg=="
    }
  },
  "recipient": {
    "landing": {
      "delivery_session": null,
      "state": "link_opened",
      "attempts_remaining": 5,
      "certificate_url": null,
      "passkey_offer": false,
      "identified_as": null,
      "delivery": {
        "title": "Sýnishorn af sendingu",
        "message": "Þetta er sýnishorn. Svona birtist sendingin viðtakanda.",
        "language": "is",
        "sender_display_name": "Fyrirtæki ehf.",
        "sender_unverified": false,
        "file_count": 1,
        "total_bytes": 245760,
        "files": [
          {
            "name": "Synishorn.pdf",
            "path": "Synishorn.pdf",
            "bytes": 245760,
            "download_url": null
          }
        ],
        "zip_download_url": null,
        "content_type": "files",
        "expires_at": "2026-11-20T09:15:05.878Z",
        "auth_methods_offered": [
          "audkenni",
          "smart_id",
          "passkey"
        ],
        "brand": {
          "name": "Parasend",
          "powered_by": "Parasend · by Justikal",
          "profile": {
            "version_id": null,
            "sender_display_name": "Fyrirtæki ehf.",
            "header_style": "band",
            "primary_color": "#1E5BB8",
            "monogram": "F",
            "logo": null,
            "icon": null,
            "support": null,
            "expired_message": {
              "is": null,
              "en": null
            },
            "theme": {
              "colors": {
                "page_background": "#F5F6FA",
                "card_background": "#FFFFFF",
                "text": "#0E1526",
                "secondary_text": "#5B6472",
                "primary": "#1E5BB8",
                "button_background": "#1E5BB8",
                "button_text": "#FFFFFF",
                "header_background": "#1E5BB8",
                "header_text": "#FFFFFF",
                "divider": "#E6E9F2"
              },
              "button_radius": 12,
              "card_radius": 14,
              "card_shadow": true,
              "font": "inter",
              "logo_height": null,
              "header_align": "left",
              "logo_background": "tile",
              "show_name_with_logo": false,
              "show_safety_note": true,
              "show_support_line": true,
              "show_sender_line": true,
              "card_footer": "default",
              "card_footer_text": {
                "is": null,
                "en": null
              },
              "layout": "card",
              "page_image": null
            }
          }
        },
        "consent_prompt_eligible": false
      }
    },
    "unlocked": {
      "delivery_session": null,
      "state": "unlocked",
      "attempts_remaining": null,
      "certificate_url": "/v1/recipient/evidence/document",
      "passkey_offer": false,
      "identified_as": null,
      "delivery": {
        "title": "Sýnishorn af sendingu",
        "message": "Þetta er sýnishorn. Svona birtist sendingin viðtakanda.",
        "language": "is",
        "sender_display_name": "Fyrirtæki ehf.",
        "sender_unverified": false,
        "file_count": 1,
        "total_bytes": 245760,
        "files": [
          {
            "name": "Synishorn.pdf",
            "path": "Synishorn.pdf",
            "bytes": 245760,
            "download_url": "/v1/recipient/files/sample/content"
          }
        ],
        "zip_download_url": null,
        "content_type": "files",
        "expires_at": "2026-11-20T09:15:05.878Z",
        "auth_methods_offered": [
          "audkenni",
          "smart_id",
          "passkey"
        ],
        "brand": {
          "name": "Parasend",
          "powered_by": "Parasend · by Justikal",
          "profile": {
            "version_id": null,
            "sender_display_name": "Fyrirtæki ehf.",
            "header_style": "band",
            "primary_color": "#1E5BB8",
            "monogram": "F",
            "logo": null,
            "icon": null,
            "support": null,
            "expired_message": {
              "is": null,
              "en": null
            },
            "theme": {
              "colors": {
                "page_background": "#F5F6FA",
                "card_background": "#FFFFFF",
                "text": "#0E1526",
                "secondary_text": "#5B6472",
                "primary": "#1E5BB8",
                "button_background": "#1E5BB8",
                "button_text": "#FFFFFF",
                "header_background": "#1E5BB8",
                "header_text": "#FFFFFF",
                "divider": "#E6E9F2"
              },
              "button_radius": 12,
              "card_radius": 14,
              "card_shadow": true,
              "font": "inter",
              "logo_height": null,
              "header_align": "left",
              "logo_background": "tile",
              "show_name_with_logo": false,
              "show_safety_note": true,
              "show_support_line": true,
              "show_sender_line": true,
              "card_footer": "default",
              "card_footer_text": {
                "is": null,
                "en": null
              },
              "layout": "card",
              "page_image": null
            }
          }
        },
        "consent_prompt_eligible": false
      }
    },
    "expired": {
      "error": {
        "type": "authentication_error",
        "code": "delivery_link_expired",
        "message": "This delivery link has expired.",
        "request_id": "req_848634cb0db0007a19364368",
        "brand": {
          "name": "Parasend",
          "powered_by": "Parasend · by Justikal",
          "profile": {
            "version_id": null,
            "sender_display_name": "Fyrirtæki ehf.",
            "header_style": "band",
            "primary_color": "#1E5BB8",
            "monogram": "F",
            "logo": null,
            "icon": null,
            "support": null,
            "expired_message": {
              "is": null,
              "en": null
            },
            "theme": {
              "colors": {
                "page_background": "#F5F6FA",
                "card_background": "#FFFFFF",
                "text": "#0E1526",
                "secondary_text": "#5B6472",
                "primary": "#1E5BB8",
                "button_background": "#1E5BB8",
                "button_text": "#FFFFFF",
                "header_background": "#1E5BB8",
                "header_text": "#FFFFFF",
                "divider": "#E6E9F2"
              },
              "button_radius": 12,
              "card_radius": 14,
              "card_shadow": true,
              "font": "inter",
              "logo_height": null,
              "header_align": "left",
              "logo_background": "tile",
              "show_name_with_logo": false,
              "show_safety_note": true,
              "show_support_line": true,
              "show_sender_line": true,
              "card_footer": "default",
              "card_footer_text": {
                "is": null,
                "en": null
              },
              "layout": "card",
              "page_image": null
            }
          }
        }
      }
    },
    "assets": {}
  }
}