openapi: 3.1.0 info: title: Twilio SendGrid Provisioning Account Designs API summary: The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customer accounts. description: 'The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customer accounts. This API is for companies that have a formal reseller partnership with Twilio SendGrid. You can access Twilio SendGrid sub-account functionality without becoming a reseller. If you require sub-account functionality, see the Twilio [SendGrid Subusers](https://docs.sendgrid.com/ui/account-and-settings/subusers) feature, which is available with [Pro and Premier plans](https://sendgrid.com/pricing/).' 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: account_provisioning servers: - url: https://api.sendgrid.com description: for global users and subusers - url: https://api.eu.sendgrid.com description: for EU regional subusers security: - BearerAuth: [] tags: - name: Designs description: Twilio SendGrid Marketing Campaigns Designs API paths: /v3/designs: post: operationId: CreateDesign summary: Create Design tags: - Designs description: '**This endpoint allows you to create a new design**. You 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/). The Design Library can also convert your design’s 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). Because 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: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

\n
\n \n \n \n \n \n
Ahoy, World!

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " 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**. Modifying an existing design is often the easiest way to create something new. You 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. You can modify your duplicate’s name at the time of creation by passing an updated value to the `name` field when making the initial request. More 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: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

\n
\n \n \n \n \n \n
Ahoy, World!

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " 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: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

\n
\n \n \n \n \n \n
Ahoy, World!

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " 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/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.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' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' patch: operationId: UpdateDesign summary: Update Design tags: - Designs description: "**This endpoint allows you to edit a design**.\n\nThe Design API supports PATCH requests, which allow you to make partial updates to a single design. Passing data to a specific field will update only the data stored in that field; all other fields will be unaltered.\n\nFor example, updating a design's name requires that you make a PATCH request to this endpoint with data specified for the `name` field only.\n\n```\n{\n \"name\": \"\"\n}\n```" requestBody: content: application/json: schema: type: object properties: name: type: string description: Name of the Design. maxLength: 100 default: My Design html_content: type: string description: The HTML content of the Design. maxLength: 1048576 plain_content: type: string description: Plain text content of the Design. maxLength: 1048576 default: generate_plain_content: type: boolean description: If true, plain_content is always generated from html_content. If false, plain_content is not altered. default: true subject: type: string description: Subject of the Design. maxLength: 5000 categories: type: array description: The list of categories applied to the design uniqueItems: true maxItems: 10 items: type: string maxLength: 255 example: name: Ahoy, World! subject: Getting Started html_content: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

\n
\n \n \n \n \n \n
Ahoy, World!

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " generate_plain_content: false categories: - promotions 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: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

\n
\n \n \n \n \n \n
Ahoy, World!

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " generate_plain_content: false thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png subject: Getting Started created_at: '2021-04-30T18:51:20Z' updated_at: '2021-04-30T18:51:20Z' editor: design categories: - promotions '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' delete: operationId: DeleteDesign summary: Delete Design tags: - Designs description: '**This endpoint allows you to delete a single design**. Be sure to check the ID of the design you intend to delete before making this request; deleting a design is a permanent action.' responses: '204': description: '' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' /v3/designs/pre-builts: get: operationId: ListPreBuiltDesign summary: List SendGrid Pre-built Designs tags: - Designs description: '**This endpoint allows you to retrieve a list of pre-built designs provided by Twilio SendGrid**. Unlike the `/designs` endpoint where *your* designs are stored, a GET request made to `designs/pre-builts` will retrieve a list of the pre-built Twilio SendGrid designs. This endpoint will not return the designs stored in your Design Library. 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. This endpoint is useful for retrieving the IDs of Twilio SendGrid designs that you want to duplicate and modify.' 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: 6ad69134-7165-48cb-964a-6c3cf03e8af8 name: Off Grid Adventures generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png subject: Welcome to the family! created_at: '2019-09-10T02:11:34Z' updated_at: '2021-01-11T21:47:52Z' editor: design categories: [] - id: b0a9c6f7-a9a1-4b52-b0c5-16fc6f4cdb2b name: Song Riddle generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/4ef3a39249f3accb8461b03950c071454a745a232508feca89a626b3e7f578d3.png subject: Welcome to Song Riddle! created_at: '2019-09-10T02:12:32Z' updated_at: '2021-01-11T21:46:43Z' editor: design categories: [] - id: f8d8da76-bcca-4cfe-b809-733887855f57 name: Ingrid & Anders 1 generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/15c97ffa97ee31693581a67526728d096eef00adfbaa34bb030d91034d477da4.png subject: Welcome to Ingrid & Anders! created_at: '2019-09-10T02:10:38Z' updated_at: '2021-01-11T21:45:05Z' editor: design categories: [] - id: 2935a7d0-7f02-4e0f-a570-dc302ce09749 name: Ingrid & Anders 2 generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/7b36a6c0955cab0c350d105114ad248700a685bd11032592cdef85ae26540afc.png subject: Check out these exclusive deals! created_at: '2019-09-10T02:09:31Z' updated_at: '2021-01-11T21:44:08Z' editor: design categories: [] - id: 7826ef14-7ba6-4dbc-91f0-a8c610ebe962 name: Ingrid & Anders 3 generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/6dd8dd73a1a62bd7a76c4313b52d7c749250d49e31b19cce718906655fcbc675.png subject: Join our VIP club and save big! created_at: '2019-09-10T02:08:29Z' updated_at: '2021-01-11T21:41:35Z' editor: design categories: [] - id: 41da47e7-d3e2-491b-a83f-f499a4139d6a name: Mercado generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/9cc87cc7671719712d9d363184995d0ec05103355db300ff03641fe9e205651d.png subject: Subject created_at: '2019-09-10T02:03:06Z' updated_at: '2021-01-11T21:39:23Z' editor: design categories: [] _metadata: self: https://api.sendgrid.com/v3/designs/pre-builts?page_token=yYzyCxj-iIVgP54t6NjKkunDCKYLLpngo-5vAsfYXz0To34U count: 6 /v3/designs/pre-builts/{id}: parameters: - name: id in: path description: The ID of the pre-built Design you want to duplicate. required: true schema: type: string format: uuid post: operationId: DuplicatePreBuiltDesign summary: Duplicate SendGrid Pre-built Design tags: - Designs description: '**This endpoint allows you to duplicate one of the pre-built Twilio SendGrid designs**. Like duplicating one of your existing designs, you 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 design will be assigned a unique ID that differentiates it from your other designs. You can retrieve the IDs for Twilio SendGrid pre-built designs using the "List SendGrid Pre-built Designs" endpoint. You can modify your duplicate’s name at the time of creation by passing an updated value to the `name` field when making the initial request. More on retrieving design IDs can be found above.' requestBody: $ref: '#/components/requestBodies/DesignDuplicateInput' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DesignOutput' examples: response: value: id: abe0877f-a224-21e2-b62e-c789d326cda5 name: Ahoy, Pre-built Design! html_content: "\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

You've found the secret!

\n
\n \n \n \n
\"Off
\n \n \n \n
\"\"
\n \n \n \n
Welcome to the family!
\n \n \n \n
You've found a community of travelers that are just like you.
\n
 
\n
We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.
\n
 
\n
Ready for your next authentic travel experience?
Browse Gallery
\n \n \n \n
\"\"
\n \n \n \n
\n
\n \n \n \n
\n \n \n \n \n
\n
\n \n \n \n
\n
\n \n \n \n \n \n
\n \n \n
\n \n \"Facebook\"\n \n \n \n \"Twitter\"\n \n \n \n \"Instagram\"\n \n \n \n \"Pinterest\"\n \n
\n

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " plain_content: 'You''ve found the secret! Welcome to the family! You''ve found a community of travelers that are just like you. We don''t want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination. Ready for your next authentic travel experience? Browse Gallery ( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ ) {{Sender_Name}} {{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}} Unsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )' generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png subject: Welcome to the family! created_at: '2021-04-30T19:15:28Z' updated_at: '2021-04-30T19:15:28Z' editor: design categories: [] '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' get: operationId: GetPreBuiltDesign summary: Get SendGrid Pre-built Design tags: - Designs description: '**This endpoint allows you to retrieve a single pre-built design**. A GET request to `/designs/pre-builts/{id}` will retrieve details about a specific pre-built design. This endpoint is valuable when retrieving details about a pre-built design that you wish to duplicate and modify.' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DesignOutput' examples: response: value: id: 6ad69134-7165-48cb-964a-6c3cf03e8af8 name: Off Grid Adventures html_content: "\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

You've found the secret!

\n
\n \n \n \n
\"Off
\n \n \n \n
\"\"
\n \n \n \n
Welcome to the family!
\n \n \n \n
You've found a community of travelers that are just like you.
\n
 
\n
We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.
\n
 
\n
Ready for your next authentic travel experience?
Browse Gallery
\n \n \n \n
\"\"
\n \n \n \n
\n
\n \n \n \n
\n \n \n \n \n
\n
\n \n \n \n
\n
\n \n \n \n \n \n
\n \n \n
\n \n \"Facebook\"\n \n \n \n \"Twitter\"\n \n \n \n \"Instagram\"\n \n \n \n \"Pinterest\"\n \n
\n

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " plain_content: 'You''ve found the secret! Welcome to the family! You''ve found a community of travelers that are just like you. We don''t want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination. Ready for your next authentic travel experience? Browse Gallery ( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ ) {{Sender_Name}} {{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}} Unsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )' generate_plain_content: true thumbnail_url: //us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png subject: Welcome to the family! created_at: '2019-09-10T02:11:34Z' updated_at: '2021-01-11T21:47:52Z' editor: design categories: [] '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiErrors' components: parameters: DesignsQueryStringsPageToken: name: page_token in: query description: token corresponding to a specific page of results, as provided by metadata schema: type: string DesignsQueryStringsPageSize: name: page_size in: query description: number of results to return schema: type: integer minimum: 0 default: 100 DesignsQueryStringsSummary: name: summary in: query description: set to false to return all fields schema: type: boolean default: true schemas: Metadata: title: _metadata type: object properties: prev: type: string format: uri self: type: string format: uri next: type: string format: uri count: type: integer minimum: 0 ApiErrors: title: errors type: object properties: errors: type: array items: $ref: '#/components/schemas/ApiError' DesignDuplicateInput: title: Design Duplicate Design Input type: object properties: name: type: string description: The name of the new design. default: 'Duplicate: ' editor: type: string description: The editor used in the UI. $ref: '#/components/schemas/Editor' example: name: Ahoy, Cake or Pie Cafe! editor: design DesignOutputSummary: title: Design Output - Summary example: 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 type: object properties: id: type: string description: ID of the Design. format: uuid updated_at: type: string description: Datetime that Design was last updated. format: ISO 8601 date-time created_at: type: string description: Datetime that Design was created. format: ISO 8601 date-time thumbnail_url: type: string description: A Thumbnail preview of the template's html content. name: type: string description: The name of the new design. default: 'Duplicate: ' editor: type: string description: The editor used in the UI. $ref: '#/components/schemas/Editor' ApiError: title: error type: object properties: message: type: string field: type: string error_id: type: string required: - message - field - error_id DesignOutput: title: Design Output type: object properties: name: type: string description: The name of the new design. default: 'Duplicate: ' editor: type: string description: The editor used in the UI. $ref: '#/components/schemas/Editor' html_content: type: string description: The HTML content of the Design. maxLength: 1048576 plain_content: type: string description: Plain text content of the Design. maxLength: 1048576 default: required: - html_content Editor: type: string enum: - code - design DesignInput: title: Design Input example: name: Ahoy, World! editor: design subject: Getting Started html_content: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n \n
\n \n \n \n
\n

\n
\n \n \n \n \n \n
Ahoy, World!

{{Sender_Name}}

{{Sender_Address}}, {{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe Preferences

\n \n
\n
\n
\n
\n
\n \n " plain_content: 'Ahoy, World! {{Sender_Name}} {{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}} Unsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )' type: object properties: name: type: string description: The name of the new design. default: 'Duplicate: ' editor: type: string description: The editor used in the UI. $ref: '#/components/schemas/Editor' html_content: type: string description: The HTML content of the Design. maxLength: 1048576 plain_content: type: string description: Plain text content of the Design. maxLength: 1048576 default: required: - html_content requestBodies: DesignDuplicateInput: content: application/json: schema: $ref: '#/components/schemas/DesignDuplicateInput' securitySchemes: BearerAuth: type: http scheme: bearer description: Twilio SendGrid requires you to authenticate with its APIs using an API key. The API key must be sent as a bearer token in the Authorization header. externalDocs: description: Twilio SendGrid's official developer documentation. url: https://www.twilio.com/docs/sendgrid