openapi: 3.1.0
security:
- BearerAuth: []
info:
title: Twilio SendGrid Marketing Campaigns Designs
summary: The Twilio SendGrid Designs API offers the ability to manage assets stored
in the Twilio SendGrid Design Library.
description: 'The Twilio SendGrid Designs API offers the ability to manage assets
stored in the Twilio SendGrid [Design Library](https://mc.sendgrid.com/design-library/my-designs).
The Design Library is a feature-rich email layout tool and media repository. You
can [build designs for all your marketing email needs](https://sendgrid.com/docs/ui/sending-email/working-with-marketing-campaigns-email-designs/),
including Single Sends and Automations.
You can also duplicate and then modify one of the pre-built designs provided by
Twilio SendGrid to get you started.
The Designs API provides a REST-like interface for creating new designs, retrieving
a list of existing designs, duplicating or updating a design, and deleting a design.'
termsOfService: https://www.twilio.com/legal/tos
contact:
name: Twilio SendGrid Support
url: https://support.sendgrid.com/hc/en-us
license:
name: MIT
url: https://code.hq.twilio.com/twilio/sendgrid-oas/blob/main/LICENSE
version: 1.0.0
x-sendgrid:
libraryPackage: mc_designs
servers:
- url: https://api.sendgrid.com
description: The Twilio SendGrid v3 API
paths:
/v3/designs:
post:
operationId: CreateDesign
summary: Create Design
tags:
- Designs
description: "**This endpoint allows you to create a new design**.\n\nYou can\
\ add a new design by passing data, including a string of HTML email content,\
\ to `/designs`. When creating designs from scratch, be aware of the styling\
\ constraints inherent to many email clients. For a list of best practices,\
\ see our guide to [Cross-Platform Email Design](https://sendgrid.com/docs/ui/sending-email/cross-platform-html-design/).\n\
\nThe Design Library can also convert your design\u2019s HTML elements into\
\ drag and drop modules that are editable in the Designs Library user interface.\
\ For more, visit the [Design and Code Editor documentation](https://sendgrid.com/docs/ui/sending-email/editor/#drag--drop-markup).\n\
\nBecause the `/designs` endpoint makes it easy to add designs, you can create\
\ a design with your preferred tooling or migrate designs you already own\
\ without relying on the Design Library UI."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DesignInput'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DesignOutput'
examples:
response:
value:
id: 3247eaea-c912-42a3-b0bc-60bdaf210396
name: Ahoy, World!
html_content: "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\
\ \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html\
\ data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"\
http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"\
Content-Type\" content=\"text/html; charset=utf-8\">\n \
\ <meta name=\"viewport\" content=\"width=device-width, initial-scale=1,\
\ minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n\
\ <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\"\
>\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n\
\ <xml>\n <o:OfficeDocumentSettings>\n \
\ <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n\
\ </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n\
\ <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\"\
>\n body {width: 600px;margin: 0 auto;}\n table {border-collapse:\
\ collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace:\
\ 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n\
<![endif]-->\n <style type=\"text/css\">\n body, p,\
\ div {\n font-family: arial,helvetica,sans-serif;\n \
\ font-size: 14px;\n }\n body {\n color: #000000;\n\
\ }\n body a {\n color: #1188E6;\n text-decoration:\
\ none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper\
\ {\n width:100% !important;\n table-layout: fixed;\n\
\ -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust:\
\ 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust:\
\ 100%;\n }\n img.max-width {\n max-width: 100% !important;\n\
\ }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3\
\ {\n width: 33.333%;\n }\n .column.of-4 {\n \
\ width: 25%;\n }\n ul ul ul ul {\n list-style-type:\
\ disc !important;\n }\n ol ol {\n list-style-type:\
\ lower-roman !important;\n }\n ol ol ol {\n list-style-type:\
\ lower-latin !important;\n }\n ol ol ol ol {\n list-style-type:\
\ decimal !important;\n }\n @media screen and (max-width:480px)\
\ {\n .preheader .rightColumnContent,\n .footer .rightColumnContent\
\ {\n text-align: left !important;\n }\n .preheader\
\ .rightColumnContent div,\n .preheader .rightColumnContent\
\ span,\n .footer .rightColumnContent div,\n .footer\
\ .rightColumnContent span {\n text-align: left !important;\n\
\ }\n .preheader .rightColumnContent,\n .preheader\
\ .leftColumnContent {\n font-size: 80% !important;\n\
\ padding: 5px 0;\n }\n table.wrapper-mobile\
\ {\n width: 100% !important;\n table-layout:\
\ fixed;\n }\n img.max-width {\n height: auto\
\ !important;\n max-width: 100% !important;\n }\n\
\ a.bulletproof-button {\n display: block !important;\n\
\ width: auto !important;\n font-size: 80%;\n\
\ padding-left: 0 !important;\n padding-right:\
\ 0 !important;\n }\n .columns {\n width: 100%\
\ !important;\n }\n .column {\n display: block\
\ !important;\n width: 100% !important;\n padding-left:\
\ 0 !important;\n padding-right: 0 !important;\n \
\ margin-left: 0 !important;\n margin-right: 0 !important;\n\
\ }\n .social-icon-column {\n display: inline-block\
\ !important;\n }\n }\n </style>\n <!--user entered\
\ Head Start--><!--End Head user entered-->\n </head>\n \
\ <body>\n <center class=\"wrapper\" data-link-color=\"\
#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif;\
\ color:#000000; background-color:#FFFFFF;\">\n <div\
\ class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"\
0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"\
#FFFFFF\">\n <tr>\n <td valign=\"top\"\
\ bgcolor=\"#FFFFFF\" width=\"100%\">\n <table\
\ width=\"100%\" role=\"content-container\" class=\"outer\"\
\ align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"\
0\">\n <tr>\n <td width=\"\
100%\">\n <table width=\"100%\" cellpadding=\"\
0\" cellspacing=\"0\" border=\"0\">\n \
\ <tr>\n <td>\n \
\ <!--[if mso]>\n <center>\n <table><tr><td width=\"\
600\">\n <![endif]-->\n \
\ <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\"\
\ border=\"0\" style=\"width:100%; max-width:600px;\" align=\"\
center\">\n <tr>\n \
\ <td role=\"modules-container\"\
\ style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\"\
\ bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"\
module preheader preheader-hide\" role=\"module\" data-type=\"\
preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\"\
\ width=\"100%\" style=\"display: none !important; mso-hide:\
\ all; visibility: hidden; opacity: 0; color: transparent; height:\
\ 0; width: 0;\">\n <tr>\n <td role=\"module-content\"\
>\n <p></p>\n </td>\n </tr>\n </table><table\
\ class=\"module\" role=\"module\" data-type=\"text\" border=\"\
0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"\
table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\"\
\ data-mc-module-version=\"2019-10-22\">\n <tbody>\n \
\ <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px;\
\ text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\
\" role=\"module-content\"><div><div style=\"font-family: inherit;\
\ text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n\
\ </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\"\
\ class=\"module\" role=\"module\" data-type=\"unsubscribe\"\
\ style=\"color:#444444; font-size:12px; line-height:20px; padding:16px\
\ 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"\
><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\"\
\ style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p\
\ style=\"font-size:12px; line-height:20px;\"><span class=\"\
Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span\
\ class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>,\
\ <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span>\
\ <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p\
\ style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\"\
\ href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a>\
\ - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\"\
\ class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe\
\ Preferences</a></p></div></td>\n \
\ </tr>\n </table>\n\
\ <!--[if mso]>\n \
\ </td>\n \
\ </tr>\n </table>\n \
\ </center>\n \
\ <![endif]-->\n </td>\n \
\ </tr>\n </table>\n\
\ </td>\n </tr>\n \
\ </table>\n </td>\n </tr>\n\
\ </table>\n </div>\n </center>\n </body>\n\
\ </html>"
plain_content: 'Ahoy, World!
{{Sender_Name}}
{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}
Unsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences
( {{{unsubscribe_preferences}}} )'
generate_plain_content: false
thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/kjlrmded0qnrscv8zqr39npoimrpdwgiax59q8iq6ovj7yoks2fzxoxpfjpwph6o.png
subject: Getting Started
created_at: '2021-04-30T18:51:20Z'
updated_at: '2021-04-30T18:51:20Z'
editor: design
categories: []
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrors'
get:
operationId: ListDesign
summary: List Designs
tags:
- Designs
description: '**This endpoint allows you to retrieve a list of designs already
stored in your Design Library**.
A GET request to `/designs` will return a list of your existing designs. This
endpoint will not return the pre-built Twilio SendGrid designs. Pre-built
designs can be retrieved using the `/designs/pre-builts` endpoint, which is
detailed below.
By default, you will receive 100 results per request; however, you can modify
the number of results returned by passing an integer to the `page_size` query
parameter.'
parameters:
- $ref: '#/components/parameters/DesignsQueryStringsPageSize'
- $ref: '#/components/parameters/DesignsQueryStringsPageToken'
- $ref: '#/components/parameters/DesignsQueryStringsSummary'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/DesignOutputSummary'
_metadata:
$ref: '#/components/schemas/Metadata'
examples:
response:
value:
result:
- id: 3247eaea-c912-42a3-b0bc-60bdaf210396
name: Welcome Email
generate_plain_content: true
thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/llny8o5b3m636z92p7hbjnmq1jvpka39p370jwtin2s1wxv7x1sgm0y5fk518d0s.png
subject: Welcom to the Cake or Pie Cafe
created_at: '2021-04-09T17:29:46Z'
updated_at: '2021-04-09T17:29:55Z'
editor: code
categories:
- welcome
- new customer
- id: 02dfd792-f31f-439a-a79e-5c47fbcfdbac
name: Monthly Promo
generate_plain_content: true
thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/hfyxahd7ues2ajuoeoqq2xe6ibdasl1q89ox0y9ncya2ftpoicssmtf9ddus4c39.png
subject: Free Dozen Cupcakes
created_at: '2021-04-09T17:29:21Z'
updated_at: '2021-04-09T17:29:42Z'
editor: design
categories:
- promo
- coupon
- id: e54be823-19ef-4c6f-8b60-efd7514f492d
name: 'Duplicate: Ingrid & Anders'
generate_plain_content: true
thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/12kni9gjpyb9uxmwr9vk7unycjr70u95zoyhe9sg2zounul2zg7dih1s20k13q2z.png
subject: Welcome to Ingrid & Anders!
created_at: '2020-10-09T17:33:46Z'
updated_at: '2021-04-07T19:57:52Z'
editor: design
categories: []
_metadata:
self: https://api.sendgrid.com/v3/designs?page_token=vHdvHCg0w1F-TmWJcPNpTEnFY2aPEmRBHONwOgZ6TgJbX2_I
count: 3
/v3/designs/{id}:
parameters:
- name: id
in: path
description: The ID of the Design you want to duplicate.
required: true
schema:
type: string
format: uuid
post:
operationId: DuplicateDesign
summary: Duplicate Design
tags:
- Designs
description: "**This endpoint allows you to duplicate one of your existing designs**.\n\
\nModifying an existing design is often the easiest way to create something\
\ new.\n\nYou are not required to pass any data in the body of a request to\
\ this endpoint. If you choose to leave the `name` field blank, your duplicate\
\ will be assigned the name of the design it was copied from with the text\
\ \"Duplicate: \" prepended to it. This name change is only a convenience,\
\ as the duplicate will be assigned a unique ID that differentiates it from\
\ your other designs.\n\nYou can modify your duplicate\u2019s name at the\
\ time of creation by passing an updated value to the `name` field when making\
\ the initial request.\nMore on retrieving design IDs can be found below."
requestBody:
$ref: '#/components/requestBodies/DesignDuplicateInput'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DesignOutput'
examples:
response:
value:
id: 15b85720-ce48-48ef-8a07-672b0d3455da
name: Ahoy, Cake or Pie Cafe!
html_content: "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\
\ \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html\
\ data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"\
http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"\
Content-Type\" content=\"text/html; charset=utf-8\">\n \
\ <meta name=\"viewport\" content=\"width=device-width, initial-scale=1,\
\ minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n\
\ <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\"\
>\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n\
\ <xml>\n <o:OfficeDocumentSettings>\n \
\ <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n\
\ </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n\
\ <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\"\
>\n body {width: 600px;margin: 0 auto;}\n table {border-collapse:\
\ collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace:\
\ 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n\
<![endif]-->\n <style type=\"text/css\">\n body, p,\
\ div {\n font-family: arial,helvetica,sans-serif;\n \
\ font-size: 14px;\n }\n body {\n color: #000000;\n\
\ }\n body a {\n color: #1188E6;\n text-decoration:\
\ none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper\
\ {\n width:100% !important;\n table-layout: fixed;\n\
\ -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust:\
\ 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust:\
\ 100%;\n }\n img.max-width {\n max-width: 100% !important;\n\
\ }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3\
\ {\n width: 33.333%;\n }\n .column.of-4 {\n \
\ width: 25%;\n }\n ul ul ul ul {\n list-style-type:\
\ disc !important;\n }\n ol ol {\n list-style-type:\
\ lower-roman !important;\n }\n ol ol ol {\n list-style-type:\
\ lower-latin !important;\n }\n ol ol ol ol {\n list-style-type:\
\ decimal !important;\n }\n @media screen and (max-width:480px)\
\ {\n .preheader .rightColumnContent,\n .footer .rightColumnContent\
\ {\n text-align: left !important;\n }\n .preheader\
\ .rightColumnContent div,\n .preheader .rightColumnContent\
\ span,\n .footer .rightColumnContent div,\n .footer\
\ .rightColumnContent span {\n text-align: left !important;\n\
\ }\n .preheader .rightColumnContent,\n .preheader\
\ .leftColumnContent {\n font-size: 80% !important;\n\
\ padding: 5px 0;\n }\n table.wrapper-mobile\
\ {\n width: 100% !important;\n table-layout:\
\ fixed;\n }\n img.max-width {\n height: auto\
\ !important;\n max-width: 100% !important;\n }\n\
\ a.bulletproof-button {\n display: block !important;\n\
\ width: auto !important;\n font-size: 80%;\n\
\ padding-left: 0 !important;\n padding-right:\
\ 0 !important;\n }\n .columns {\n width: 100%\
\ !important;\n }\n .column {\n display: block\
\ !important;\n width: 100% !important;\n padding-left:\
\ 0 !important;\n padding-right: 0 !important;\n \
\ margin-left: 0 !important;\n margin-right: 0 !important;\n\
\ }\n .social-icon-column {\n display: inline-block\
\ !important;\n }\n }\n </style>\n <!--user entered\
\ Head Start--><!--End Head user entered-->\n </head>\n \
\ <body>\n <center class=\"wrapper\" data-link-color=\"\
#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif;\
\ color:#000000; background-color:#FFFFFF;\">\n <div\
\ class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"\
0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"\
#FFFFFF\">\n <tr>\n <td valign=\"top\"\
\ bgcolor=\"#FFFFFF\" width=\"100%\">\n <table\
\ width=\"100%\" role=\"content-container\" class=\"outer\"\
\ align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"\
0\">\n <tr>\n <td width=\"\
100%\">\n <table width=\"100%\" cellpadding=\"\
0\" cellspacing=\"0\" border=\"0\">\n \
\ <tr>\n <td>\n \
\ <!--[if mso]>\n <center>\n <table><tr><td width=\"\
600\">\n <![endif]-->\n \
\ <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\"\
\ border=\"0\" style=\"width:100%; max-width:600px;\" align=\"\
center\">\n <tr>\n \
\ <td role=\"modules-container\"\
\ style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\"\
\ bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"\
module preheader preheader-hide\" role=\"module\" data-type=\"\
preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\"\
\ width=\"100%\" style=\"display: none !important; mso-hide:\
\ all; visibility: hidden; opacity: 0; color: transparent; height:\
\ 0; width: 0;\">\n <tr>\n <td role=\"module-content\"\
>\n <p></p>\n </td>\n </tr>\n </table><table\
\ class=\"module\" role=\"module\" data-type=\"text\" border=\"\
0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"\
table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\"\
\ data-mc-module-version=\"2019-10-22\">\n <tbody>\n \
\ <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px;\
\ text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\
\" role=\"module-content\"><div><div style=\"font-family: inherit;\
\ text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n\
\ </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\"\
\ class=\"module\" role=\"module\" data-type=\"unsubscribe\"\
\ style=\"color:#444444; font-size:12px; line-height:20px; padding:16px\
\ 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"\
><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\"\
\ style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p\
\ style=\"font-size:12px; line-height:20px;\"><span class=\"\
Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span\
\ class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>,\
\ <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span>\
\ <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p\
\ style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\"\
\ href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a>\
\ - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\"\
\ class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe\
\ Preferences</a></p></div></td>\n \
\ </tr>\n </table>\n\
\ <!--[if mso]>\n \
\ </td>\n \
\ </tr>\n </table>\n \
\ </center>\n \
\ <![endif]-->\n </td>\n \
\ </tr>\n </table>\n\
\ </td>\n </tr>\n \
\ </table>\n </td>\n </tr>\n\
\ </table>\n </div>\n </center>\n </body>\n\
\ </html>"
plain_content: 'Ahoy, World!
{{Sender_Name}}
{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}
Unsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences
( {{{unsubscribe_preferences}}} )'
generate_plain_content: false
thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/79bb769ae6464960a307040120ad6f9921896fe9825e845ad1f24d12285ea068.png
subject: Getting Started
created_at: '2021-04-30T19:00:16Z'
updated_at: '2021-04-30T19:00:16Z'
editor: design
categories: []
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrors'
get:
operationId: GetDesign
summary: Get Design
tags:
- Designs
description: '**This endpoint allows you to retrieve a single design**.
A GET request to `/designs/{id}` will retrieve details about a specific design
in your Design Library.
This endpoint is valuable when retrieving information stored in a field that
you wish to update using a PATCH request.'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DesignOutput'
examples:
response:
value:
id: 15b85720-ce48-48ef-8a07-672b0d3455da
name: Ahoy, World!
html_content: "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\
\ \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html\
\ data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"\
http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"\
Content-Type\" content=\"text/html; charset=utf-8\">\n \
\ <meta name=\"viewport\" content=\"width=device-width, initial-scale=1,\
\ minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n\
\ <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\"\
>\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n\
\ <xml>\n <o:OfficeDocumentSettings>\n \
\ <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n\
\ </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n\
\ <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\"\
>\n body {width: 600px;margin: 0 auto;}\n table {border-collapse:\
\ collapse;}\n
# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sendgrid/refs/heads/main/openapi/tsg_mc_designs_v3.yaml