Linked projects API methods

Linked projects enable white-label sending through Sidemail. Each linked project has access to the templates of the parent project (via template ID, not template names). We recommend creating one linked project per user for optimal white-label functionality.

Available API endpoints:

  • POST https://api.sidemail.io/v1/project
  • GET https://api.sidemail.io/v1/project
  • PATCH https://api.sidemail.io/v1/project
  • DELETE https://api.sidemail.io/v1/project

Using linked projects (example)

This outlines how a linked project is designed for white-label email delivery:

  1. Create a linked project for each user of your application.
  2. Customize the email template design by updating the linked project.
  3. Send emails through linked projects using their respective API keys.
const fetch = require("node-fetch");

// create a linked project & save API key from `created.apiKey` to your datastore
const { created } = (
    await fetch("https//api.sidemail.io/v1/project", {
        method: "POST",
        headers: { Authorization: "Bearer " + "replace-with-main-project-api-key" },
        body: JSON.stringify({ name: "Customer X linked project" }),
    })
).toJson();

// update logo & colors
await fetch("https//api.sidemail.io/v1/project", {
    method: "PATCH",
    headers: { Authorization: "Bearer " + created.apiKey },
    body: JSON.stringify({
        emailTemplateDesign: {
            logo: {
                sizeWidth: 50,
                href: "https://example.com",
                file:
                    "PHN2ZyBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGwtcnVsZT0iZXZlbm9kZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLW1pdGVybGltaXQ9IjIiIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJtMTIgNS43MmMtMi42MjQtNC41MTctMTAtMy4xOTgtMTAgMi40NjEgMCAzLjcyNSA0LjM0NSA3LjcyNyA5LjMwMyAxMi41NC4xOTQuMTg5LjQ0Ni4yODMuNjk3LjI4M3MuNTAzLS4wOTQuNjk3LS4yODNjNC45NzctNC44MzEgOS4zMDMtOC44MTQgOS4zMDMtMTIuNTQgMC01LjY3OC03LjM5Ni02Ljk0NC0xMC0yLjQ2MXoiIGZpbGwtcnVsZT0ibm9uemVybyIvPjwvc3ZnPg==",
            },
            font: { name: "Acme" },
            colors: { highlight: "#0000FF", isDarkModeEnabled: true },
        },
    }),
});

// send emails (a linked project has access to parent project templates via `templateId`)
await fetch("https//api.sidemail.io/v1/email/send", {
    method: "POST",
    headers: { Authorization: "Bearer " + created.apiKey },
    body: JSON.stringify({
        toAddress: "user@email.com",
        fromAddress: "you@example.com",
        fromName: "Your app",
        templateId: "65dc4595af2e7a530209b414",
    }),
});

Create a linked project

A linked project is automatically associated with a regular project using the provided API key in the request. To personalize the email template design, make a subsequent update API request. Linked projects will be visible within the parent project on the API page in your Sidemail dashboard.

It's crucial to save the apiKey provided in the response, as it is required for subsequent API requests related to this linked project.

POST https://api.sidemail.io/v1/project

Example:

{
    "name": "Lorem ipsum"
}

Parameters

name string
Name of the linked project as displayed in the Sidemail dashboard.

Returns

{
    "created": {
        "id": "65d75fea9cca1727dc110e1b",
        "apiKey": "TcL6gLeiok8KiQf1ggqkfiA6n888w4r4i0cSqeEM"
    }
}

id string
Unique identifier of the linked project.

apiKey string
Store this value for subsequent API requests related to this linked project (provided only once).

Update a linked project

Updates a linked project based on the provided API key in the Authorization header.

PATCH https://api.sidemail.io/v1/project

Example:

{
    "name": "New name",
    "emailTemplateDesign": {
        "logo": {
            "sizeWidth": 50,
            "href": "https://example.com",
            "file": "PHN2ZyBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGwtcnVsZT0iZXZlbm9kZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLW1pdGVybGltaXQ9IjIiIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJtMTIgNS43MmMtMi42MjQtNC41MTctMTAtMy4xOTgtMTAgMi40NjEgMCAzLjcyNSA0LjM0NSA3LjcyNyA5LjMwMyAxMi41NC4xOTQuMTg5LjQ0Ni4yODMuNjk3LjI4M3MuNTAzLS4wOTQuNjk3LS4yODNjNC45NzctNC44MzEgOS4zMDMtOC44MTQgOS4zMDMtMTIuNTQgMC01LjY3OC03LjM5Ni02Ljk0NC0xMC0yLjQ2MXoiIGZpbGwtcnVsZT0ibm9uemVybyIvPjwvc3ZnPg=="
        },
        "font": { "name": "Acme" },
        "colors": { "highlight": "#0000FF", "isDarkModeEnabled": true },
        "unsubscribeText": "Darse de baja",
        "footerTextTransactional": "You're receiving these emails because you registered for Acme Inc."
    }
}

Parameters

name string
The name of the linked project for your reference in the Sidemail dashboard.

emailTemplateDesign object
The design of the email template, with its properties described below.

Email template design object

font object
The primary font for the email template. Font object properties are described below.

fontFallback object
Fallback font for email templates on clients that don't support custom fonts. Font fallback object properties are described below.

colors object
Color scheme for the email template. Colors object properties are described below.

logo object
The logo of the email design. Logo object properties are described below.

unsubscribeText string
The text of the unsubscribe link displayed at the bottom of the email template.

unsubscribePageTitle string
The title shown on the unsubscribe page.

unsubscribePageDescription string
The description shown on the unsubscribe page.

footerTextPromotional string
The footer text for promotional emails shown at the bottom of the email template. Some markdown formatting is supported: hyperlink, bold, italics, strikethrough. Variables are supported via {variable} syntax.

footerTextTransactional string
The footer text for transactional emails shown at the bottom of the email template. Some markdown formatting is supported: hyperlink, bold, italics, strikethrough. Variables are supported via {variable} syntax.

Font object

name string
The name of a specific font. Supported fonts (the name must match exactly):

sans-serif, serif, monospace, ABeeZee, Abel, Abhaya Libre, Abril Fatface, Aclonica, Acme, Actor, Adamina, Advent Pro, Aguafina Script, Akronim, Aladin, Alata, Alatsi, Aldrich, Alef, Alegreya, Alegreya SC, Alegreya Sans, Alegreya Sans SC, Aleo, Alex Brush, Alfa Slab One, Alice, Alike, Alike Angular, Allan, Allerta, Allerta Stencil, Allura, Almarai, Almendra, Almendra Display, Almendra SC, Amarante, Amaranth, Amatic SC, Amethysta, Amiko, Amiri, Amita, Anaheim, Andada, Andika, Angkor, Annie Use Your Telescope, Anonymous Pro, Antic, Antic Didone, Antic Slab, Anton, Arapey, Arbutus, Arbutus Slab, Architects Daughter, Archivo, Archivo Black, Archivo Narrow, Aref Ruqaa, Arima Madurai, Arimo, Arizonia, Armata, Arsenal, Artifika, Arvo, Arya, Asap, Asap Condensed, Asar, Asset, Assistant, Astloch, Asul, Athiti, Atma, Atomic Age, Aubrey, Audiowide, Autour One, Average, Average Sans, Averia Gruesa Libre, Averia Libre, Averia Sans Libre, Averia Serif Libre, B612, B612 Mono, Bad Script, Bahiana, Bahianita, Bai Jamjuree, Baloo 2, Baloo Bhai 2, Baloo Bhaina 2, Baloo Chettan 2, Baloo Da 2, Baloo Paaji 2, Baloo Tamma 2, Baloo Tammudu 2, Baloo Thambi 2, Balthazar, Bangers, Barlow, Barlow Condensed, Barlow Semi Condensed, Barriecito, Barrio, Basic, Baskervville, Battambang, Baumans, Bayon, Be Vietnam, Bebas Neue, Belgrano, Bellefair, Belleza, Bellota, Bellota Text, BenchNine, Bentham, Berkshire Swash, Beth Ellen, Bevan, Big Shoulders Display, Big Shoulders Text, Bigelow Rules, Bigshot One, Bilbo, Bilbo Swash Caps, BioRhyme, BioRhyme Expanded, Biryani, Bitter, Black And White Picture, Black Han Sans, Black Ops One, Blinker, Bokor, Bonbon, Boogaloo, Bowlby One, Bowlby One SC, Brawler, Bree Serif, Bubblegum Sans, Bubbler One, Buda, Buenard, Bungee, Bungee Hairline, Bungee Inline, Bungee Outline, Bungee Shade, Butcherman, Butterfly Kids, Cabin, Cabin Condensed, Cabin Sketch, Caesar Dressing, Cagliostro, Cairo, Caladea, Calistoga, Calligraffitti, Cambay, Cambo, Candal, Cantarell, Cantata One, Cantora One, Capriola, Cardo, Carme, Carrois Gothic, Carrois Gothic SC, Carter One, Catamaran, Caudex, Caveat, Caveat Brush, Cedarville Cursive, Ceviche One, Chakra Petch, Changa, Changa One, Chango, Charm, Charmonman, Chathura, Chau Philomene One, Chela One, Chelsea Market, Chenla, Cherry Cream Soda, Cherry Swash, Chewy, Chicle, Chilanka, Chivo, Chonburi, Cinzel, Cinzel Decorative, Clicker Script, Coda, Coda Caption, Codystar, Coiny, Combo, Comfortaa, Comic Neue, Coming Soon, Concert One, Condiment, Content, Contrail One, Convergence, Cookie, Copse, Corben, Cormorant, Cormorant Garamond, Cormorant Infant, Cormorant SC, Cormorant Unicase, Cormorant Upright, Courgette, Courier Prime, Cousine, Coustard, Covered By Your Grace, Crafty Girls, Creepster, Crete Round, Crimson Pro, Crimson Text, Croissant One, Crushed, Cuprum, Cute Font, Cutive, Cutive Mono, DM Sans, DM Serif Display, DM Serif Text, Damion, Dancing Script, Dangrek, Darker Grotesque, David Libre, Dawning of a New Day, Days One, Dekko, Delius, Delius Swash Caps, Delius Unicase, Della Respira, Denk One, Devonshire, Dhurjati, Didact Gothic, Diplomata, Diplomata SC, Do Hyeon, Dokdo, Domine, Donegal One, Doppio One, Dorsa, Dosis, Dr Sugiyama, Duru Sans, Dynalight, EB Garamond, Eagle Lake, East Sea Dokdo, Eater, Economica, Eczar, El Messiri, Electrolize, Elsie, Elsie Swash Caps, Emblema One, Emilys Candy, Encode Sans, Encode Sans Condensed, Encode Sans Expanded, Encode Sans Semi Condensed, Encode Sans Semi Expanded, Engagement, Englebert, Enriqueta, Erica One, Esteban, Euphoria Script, Ewert, Exo, Exo 2, Expletus Sans, Fahkwang, Fanwood Text, Farro, Farsan, Fascinate, Fascinate Inline, Faster One, Fasthand, Fauna One, Faustina, Federant, Federo, Felipa, Fenix, Finger Paint, Fira Code, Fira Mono, Fira Sans, Fira Sans Condensed, Fira Sans Extra Condensed, Fjalla One, Fjord One, Flamenco, Flavors, Fondamento, Fontdiner Swanky, Forum, Francois One, Frank Ruhl Libre, Freckle Face, Fredericka the Great, Fredoka One, Freehand, Fresca, Frijole, Fruktur, Fugaz One, GFS Didot, GFS Neohellenic, Gabriela, Gaegu, Gafata, Galada, Galdeano, Galindo, Gamja Flower, Gayathri, Gelasio, Gentium Basic, Gentium Book Basic, Geo, Geostar, Geostar Fill, Germania One, Gidugu, Gilda Display, Girassol, Give You Glory, Glass Antiqua, Glegoo, Gloria Hallelujah, Goblin One, Gochi Hand, Gorditas, Gothic A1, Gotu, Goudy Bookletter 1911, Graduate, Grand Hotel, Gravitas One, Great Vibes, Grenze, Griffy, Gruppo, Gudea, Gugi, Gupter, Gurajada, Habibi, Halant, Hammersmith One, Hanalei, Hanalei Fill, Handlee, Hanuman, Happy Monkey, Harmattan, Headland One, Heebo, Henny Penny, Hepta Slab, Herr Von Muellerhoff, Hi Melody, Hind, Hind Guntur, Hind Madurai, Hind Siliguri, Hind Vadodara, Holtwood One SC, Homemade Apple, Homenaje, IBM Plex Mono, IBM Plex Sans, IBM Plex Sans Condensed, IBM Plex Serif, IM Fell DW Pica, IM Fell DW Pica SC, IM Fell Double Pica, IM Fell Double Pica SC, IM Fell English, IM Fell English SC, IM Fell French Canon, IM Fell French Canon SC, IM Fell Great Primer, IM Fell Great Primer SC, Ibarra Real Nova, Iceberg, Iceland, Imprima, Inconsolata, Inder, Indie Flower, Inika, Inknut Antiqua, Inria Sans, Inria Serif, Inter, Irish Grover, Istok Web, Italiana, Italianno, Itim, Jacques Francois, Jacques Francois Shadow, Jaldi, Jim Nightshade, Jockey One, Jolly Lodger, Jomhuria, Jomolhari, Josefin Sans, Josefin Slab, Jost, Joti One, Jua, Judson, Julee, Julius Sans One, Junge, Jura, Just Another Hand, Just Me Again Down Here, K2D, Kadwa, Kalam, Kameron, Kanit, Kantumruy, Karla, Karma, Katibeh, Kaushan Script, Kavivanar, Kavoon, Kdam Thmor, Keania One, Kelly Slab, Kenia, Khand, Khmer, Khula, Kirang Haerang, Kite One, Knewave, KoHo, Kodchasan, Kosugi, Kosugi Maru, Kotta One, Koulen, Kranky, Kreon, Kristi, Krona One, Krub, Kulim Park, Kumar One, Kumar One Outline, Kurale, La Belle Aurore, Lacquer, Laila, Lakki Reddy, Lalezar, Lancelot, Lateef, Lato, League Script, Leckerli One, Ledger, Lekton, Lemon, Lemonada, Lexend Deca, Lexend Exa, Lexend Giga, Lexend Mega, Lexend Peta, Lexend Tera, Lexend Zetta, Libre Barcode 128, Libre Barcode 128 Text, Libre Barcode 39, Libre Barcode 39 Extended, Libre Barcode 39 Extended Text, Libre Barcode 39 Text, Libre Baskerville, Libre Caslon Display, Libre Caslon Text, Libre Franklin, Life Savers, Lilita One, Lily Script One, Limelight, Linden Hill, Literata, Liu Jian Mao Cao, Livvic, Lobster, Lobster Two, Londrina Outline, Londrina Shadow, Londrina Sketch, Londrina Solid, Long Cang, Lora, Love Ya Like A Sister, Loved by the King, Lovers Quarrel, Luckiest Guy, Lusitana, Lustria, M PLUS 1p, M PLUS Rounded 1c, Ma Shan Zheng, Macondo, Macondo Swash Caps, Mada, Magra, Maiden Orange, Maitree, Major Mono Display, Mako, Mali, Mallanna, Mandali, Manjari, Manrope, Mansalva, Manuale, Marcellus, Marcellus SC, Marck Script, Margarine, Markazi Text, Marko One, Marmelad, Martel, Martel Sans, Marvel, Mate, Mate SC, Maven Pro, McLaren, Meddon, MedievalSharp, Medula One, Meera Inimai, Megrim, Meie Script, Merienda, Merienda One, Merriweather, Merriweather Sans, Metal, Metal Mania, Metamorphous, Metrophobic, Michroma, Milonga, Miltonian, Miltonian Tattoo, Mina, Miniver, Miriam Libre, Mirza, Miss Fajardose, Mitr, Modak, Modern Antiqua, Mogra, Molengo, Molle, Monda, Monofett, Monoton, Monsieur La Doulaise, Montaga, Montez, Montserrat, Montserrat Alternates, Montserrat Subrayada, Moul, Moulpali, Mountains of Christmas, Mouse Memoirs, Mr Bedfort, Mr Dafoe, Mr De Haviland, Mrs Saint Delafield, Mrs Sheppards, Mukta, Mukta Mahee, Mukta Malar, Mukta Vaani, Muli, Mystery Quest, NTR, Nanum Brush Script, Nanum Gothic, Nanum Gothic Coding, Nanum Myeongjo, Nanum Pen Script, Neucha, Neuton, New Rocker, News Cycle, Niconne, Niramit, Nixie One, Nobile, Nokora, Norican, Nosifer, Notable, Nothing You Could Do, Noticia Text, Noto Sans, Noto Sans HK, Noto Sans JP, Noto Sans KR, Noto Sans SC, Noto Sans TC, Noto Serif, Noto Serif JP, Noto Serif KR, Noto Serif SC, Noto Serif TC, Nova Cut, Nova Flat, Nova Mono, Nova Oval, Nova Round, Nova Script, Nova Slim, Nova Square, Numans, Nunito, Nunito Sans, Odibee Sans, Odor Mean Chey, Offside, Old Standard TT, Oldenburg, Oleo Script, Oleo Script Swash Caps, Open Sans, Open Sans Condensed, Oranienbaum, Orbitron, Oregano, Orienta, Original Surfer, Oswald, Over the Rainbow, Overlock, Overlock SC, Overpass, Overpass Mono, Ovo, Oxanium, Oxygen, Oxygen Mono, PT Mono, PT Sans, PT Sans Caption, PT Sans Narrow, PT Serif, PT Serif Caption, Pacifico, Padauk, Palanquin, Palanquin Dark, Pangolin, Paprika, Parisienne, Passero One, Passion One, Pathway Gothic One, Patrick Hand, Patrick Hand SC, Pattaya, Patua One, Pavanam, Paytone One, Peddana, Peralta, Permanent Marker, Petit Formal Script, Petrona, Philosopher, Piedra, Pinyon Script, Pirata One, Plaster, Play, Playball, Playfair Display, Playfair Display SC, Podkova, Poiret One, Poller One, Poly, Pompiere, Pontano Sans, Poor Story, Poppins, Port Lligat Sans, Port Lligat Slab, Pragati Narrow, Prata, Preahvihear, Press Start 2P, Pridi, Princess Sofia, Prociono, Prompt, Prosto One, Proza Libre, Public Sans, Puritan, Purple Purse, Quando, Quantico, Quattrocento, Quattrocento Sans, Questrial, Quicksand, Quintessential, Qwigley, Racing Sans One, Radley, Rajdhani, Rakkas, Raleway, Raleway Dots, Ramabhadra, Ramaraja, Rambla, Rammetto One, Ranchers, Rancho, Ranga, Rasa, Rationale, Ravi Prakash, Red Hat Display, Red Hat Text, Redressed, Reem Kufi, Reenie Beanie, Revalia, Rhodium Libre, Ribeye, Ribeye Marrow, Righteous, Risque, Roboto, Roboto Condensed, Roboto Mono, Roboto Slab, Rochester, Rock Salt, Rokkitt, Romanesco, Ropa Sans, Rosario, Rosarivo, Rouge Script, Rozha One, Rubik, Rubik Mono One, Ruda, Rufina, Ruge Boogie, Ruluko, Rum Raisin, Ruslan Display, Russo One, Ruthie, Rye, Sacramento, Sahitya, Sail, Saira, Saira Condensed, Saira Extra Condensed, Saira Semi Condensed, Saira Stencil One, Salsa, Sanchez, Sancreek, Sansita, Sarabun, Sarala, Sarina, Sarpanch, Satisfy, Sawarabi Gothic, Sawarabi Mincho, Scada, Scheherazade, Schoolbell, Scope One, Seaweed Script, Secular One, Sedgwick Ave, Sedgwick Ave Display, Sen, Sevillana, Seymour One, Shadows Into Light, Shadows Into Light Two, Shanti, Share, Share Tech, Share Tech Mono, Shojumaru, Short Stack, Shrikhand, Siemreap, Sigmar One, Signika, Signika Negative, Simonetta, Single Day, Sintony, Sirin Stencil, Six Caps, Skranji, Slabo 13px, Slabo 27px, Slackey, Smokum, Smythe, Sniglet, Snippet, Snowburst One, Sofadi One, Sofia, Solway, Song Myung, Sonsie One, Sorts Mill Goudy, Source Code Pro, Source Sans Pro, Source Serif Pro, Space Mono, Spartan, Special Elite, Spectral, Spectral SC, Spicy Rice, Spinnaker, Spirax, Squada One, Sree Krushnadevaraya, Sriracha, Srisakdi, Staatliches, Stalemate, Stalinist One, Stardos Stencil, Stint Ultra Condensed, Stint Ultra Expanded, Stoke, Strait, Stylish, Sue Ellen Francisco, Suez One, Sulphur Point, Sumana, Sunflower, Sunshiney, Supermercado One, Sura, Suranna, Suravaram, Suwannaphum, Swanky and Moo Moo, Syncopate, Tajawal, Tangerine, Taprom, Tauri, Taviraj, Teko, Telex, Tenali Ramakrishna, Tenor Sans, Text Me One, Thasadith, The Girl Next Door, Tienne, Tillana, Timmana, Tinos, Titan One, Titillium Web, Tomorrow, Trade Winds, Trirong, Trocchi, Trochut, Trykker, Tulpen One, Turret Road, Ubuntu, Ubuntu Condensed, Ubuntu Mono, Ultra, Uncial Antiqua, Underdog, Unica One, UnifrakturCook, UnifrakturMaguntia, Unkempt, Unlock, Unna, VT323, Vampiro One, Varela, Varela Round, Vast Shadow, Vesper Libre, Viaoda Libre, Vibes, Vibur, Vidaloka, Viga, Voces, Volkhov, Vollkorn, Vollkorn SC, Voltaire, Waiting for the Sunrise, Wallpoet, Walter Turncoat, Warnes, Wellfleet, Wendy One, Wire One, Work Sans, Yanone Kaffeesatz, Yantramanav, Yatra One, Yellowtail, Yeon Sung, Yeseva One, Yesteryear, Yrsa, ZCOOL KuaiLe, ZCOOL QingKe HuangYou, ZCOOL XiaoWei, Zeyada, Zhi Mang Xing, Zilla Slab, Zilla Slab Highlight

fontSize number
The default font size in pixels. Minimum 10 pixels. Maximum 30 pixels.

lineHeight number
The default line height in a unitless format. Minimum 1. Maximum 3.

Font fallback object

name string
The name of a specific fallback font when the primary font is not supported by the email client. Supported fonts (the name must match exactly):

sans-serif, serif, monospace

fontSize number
The default font size in pixels. Minimum 10 pixels. Maximum 30 pixels.

lineHeight number
The default line height in a unitless format. Minimum 1. Maximum 3.

Colors object

highlight string hex
The primary highlight color used for button backgrounds and hyperlink text color.

bodyBg string hex
The body background color.

contentBg string hex
The content background color.

contentBorder string hex
The content border color.

buttonTextColor string hex
The button text color.

defaultTextColor string hex
The default text color.

titleTextColor string hex
The title color.

mutedTextColor string hex
The muted text color.

footerTextColor string hex
The footer text color.

isDarkModeEnabled boolean
Indicates whether the dark mode of the email template is enabled or disabled. The default is false (dark mode turned off).

Logo object

file string base64
The logo image file in Base64 format. Use null to remove a previously uploaded file.

darkModeFile string base64
A logo image file in Base64 format. This logo will only be displayed in supported email clients when dark mode is enabled. Use null to remove a previously uploaded file.

placeholder string
A text logo placeholder shown when images are blocked by the email client or the logo file fails to load.

sizeWidth number
The width of the logo image in pixels. Minimum 0. Maximum 999.

href string
The URL used as a hyperlink for the logo image. Set to null to remove the hyperlink. Default is null.

Returns

{
    "updated": {
        "id": "65d9cc698b6fe02d04f7f82b",
        "orgId": "61e6b9e048f51028dc83489f",
        "parentId": "65d75fea9cca1727dc110e1b",
        "name": "New name",
        "createdAt": "2024-02-22T14:53:30.004Z",
        "sentTotal": 0,
        "deliveriesTotal": 0,
        "bouncesTotal": 0,
        "complaintsTotal": 0,
        "suppressedTotal": 0,
        "bounceRateLimit": 7,
        "complaintRateLimit": 0.1,
        "sendingRate": 1,
        "emailTemplateDesign": {
            "unsubscribeText": "Darse de baja",
            "unsubscribePageTitle": "Unsubscribed!",
            "unsubscribePageDescription": "You won’t receive more emails.",
            "font": {
                "name": "Acme",
                "type": "google",
                "fontSize": 15,
                "lineHeight": 1.6
            },
            "fontFallback": {
                "name": "sans-serif",
                "type": "system",
                "fontSize": 14,
                "lineHeight": 1.65
            },
            "colors": {
                "highlight": "#0000FF",
                "bodyBg": "#f7f7f7",
                "contentBg": "#ffffff",
                "contentBorder": "#e6e6e6",
                "buttonTextColor": "#ffffff",
                "defaultTextColor": "#575757",
                "titleTextColor": "#222222",
                "mutedTextColor": "#b3b3b3",
                "footerTextColor": "#b3b3b3",
                "isDarkModeEnabled": true
            },
            "logo": {
                "sizeWidth": 50,
                "placeholder": "Lorem ipsum",
                "file": "https://sidemail.s3.amazonaws.com/user-uploaded/logos/7e06c4edd18af569e666a0c1dfef27b2",
                "darkModeFile": null,
                "href": "https://example.com"
            },
            "footerTextPromotional": null,
            "footerTextTransactional": "You're receiving these emails because you registered for Acme Inc."
        }
    }
}

id string
Unique identifier of the linked project.

apiKey string
This value must be stored on your side for subsequent API requests related to this linked project (provided only once).

Get a project

Retrieves project data based on the API key in the Authorization header. This method works for both normal projects created via Sidemail dashboard and linked projects created via the API.

GET https://api.sidemail.io/v1/project

Parameters

No parameters.

Returns

Returns a project object.

{
    "project": {
        "id": "65d9cc698b6fe02d04f7f82b",
        "orgId": "61e6b9e048f51028dc83489f",
        "parentId": "65d75fea9cca1727dc110e1b",
        "name": "Lorem ipsum",
        "createdAt": "2024-02-24T11:00:57.453Z",
        "sentTotal": 0,
        "deliveriesTotal": 0,
        "bouncesTotal": 0,
        "complaintsTotal": 0,
        "suppressedTotal": 0,
        "bounceRateLimit": 7,
        "complaintRateLimit": 0.1,
        "sendingRate": 1,
        "emailTemplateDesign": {
            "unsubscribeText": "Unsubscribe",
            "unsubscribePageTitle": "Unsubscribed!",
            "unsubscribePageDescription": "You won’t receive more emails.",
            "font": {
                "name": "Lato",
                "type": "google",
                "fontSize": 15,
                "lineHeight": 1.6
            },
            "fontFallback": {
                "name": "sans-serif",
                "type": "system",
                "fontSize": 14,
                "lineHeight": 1.65
            },
            "colors": {
                "highlight": "#0090f0",
                "bodyBg": "#f7f7f7",
                "contentBg": "#ffffff",
                "contentBorder": "#e6e6e6",
                "buttonTextColor": "#ffffff",
                "defaultTextColor": "#575757",
                "titleTextColor": "#222222",
                "mutedTextColor": "#b3b3b3",
                "footerTextColor": "#b3b3b3"
            },
            "logo": {
                "sizeWidth": 130,
                "placeholder": "Lorem ipsum",
                "url": null,
                "darkModeUrl": null,
                "href": null
            },
            "footerTextPromotional": null,
            "footerTextTransactional": null
        }
    }
}

Delete a linked project

DELETE https://api.sidemail.io/v1/project

Permanently deletes a linked project based on the API key in the Authorization header. It cannot be undone.

Parameters

No parameters.

Returns

Returns an object with deleted parameter that indicates the outcome of the operation.

{
    "deleted": true
}