# Update Design ## API Overview The 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 email needs](/docs/sendgrid/ui/sending-email/working-with-marketing-campaigns-email-designs/), including Single Sends, Automations, and Dynamic Templates. 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 RESTful interface for creating new designs, retrieving a list of existing designs, duplicating or updating a design, and deleting a design. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/designs/{id}","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]} ``` **This endpoint allows you to edit a design**. The 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. For example, updating a design's name requires that you make a PATCH request to this endpoint with data specified for the `name` field only. ``` { "name": "" } ``` ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}}] ``` ### Path parameters ```json [{"name":"id","in":"path","description":"The ID of the Design you want to duplicate.","required":true,"schema":{"type":"string","format":"uuid"}}] ``` ### Request body ```json {"schema":{"type":"object","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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ","generate_plain_content":false,"categories":["promotions"]},"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}}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"Design Output","type":"object","required":["html_content"],"refName":"DesignOutput","modelName":"DesignOutput","properties":{"name":{"type":"string","description":"The name of the new design.","default":"Duplicate: "},"editor":{"type":"string","description":"The editor used in the UI.","enum":["code","design"],"refName":"Editor","modelName":"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":""}}},"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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\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"]}}}}}}},{"responseCode":"400","schema":{"description":"","content":{"application/json":{"schema":{"title":"errors","type":"object","refName":"ApiErrors","modelName":"ApiErrors","properties":{"errors":{"type":"array","items":{"title":"error","type":"object","required":["message","field","error_id"],"refName":"ApiError","modelName":"ApiError","properties":{"message":{"type":"string"},"field":{"type":"string"},"error_id":{"type":"string"}}}}}}}}}},{"responseCode":"404","schema":{"description":"","content":{"application/json":{"schema":{"title":"errors","type":"object","refName":"ApiErrors","modelName":"ApiErrors","properties":{"errors":{"type":"array","items":{"title":"error","type":"object","required":["message","field","error_id"],"refName":"ApiError","modelName":"ApiError","properties":{"message":{"type":"string"},"field":{"type":"string"},"error_id":{"type":"string"}}}}}}}}}}] ``` Update Design ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644"; const data = { 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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ', generate_plain_content: false, categories: ["promotions"], }; const request = { url: `/v3/designs/${id}`, method: "PATCH", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644" data = { "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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ', "generate_plain_content": False, "categories": ["promotions"], } response = sg.client.designs._(id).patch(request_body=data) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644"; var data = @"{ ""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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n "", ""generate_plain_content"": false, ""categories"": [ ""promotions"" ] }"; var response = await client.RequestAsync( method: SendGridClient.Method.PATCH, urlPath: $"designs/{id}", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; import java.util.Arrays; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.PATCH); request.setEndpoint("/designs/f15982c1-a82c-4e87-a6b2-a4a63b4b7644"); request.setBody(new JSONObject(new HashMap() { { put("name", "Ahoy, World!"); put("subject", "Getting Started"); put("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

Ahoy, " + "World!

{{Sender_Address}}, " + "{{Sender_City}}, {{Sender_State}} {{Sender_Zip}}

Unsubscribe - Unsubscribe " + "Preferences

\n \n

\n " + "\n \n "); put("generate_plain_content", false); put("categories", Arrays.asList("promotions")); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/designs/f15982c1-a82c-4e87-a6b2-a4a63b4b7644", host) request.Method = "PATCH" request.Body = []byte(`{ "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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ", "generate_plain_content": false, "categories": [ "promotions" ] }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ", "generate_plain_content": false, "categories": [ "promotions" ] }'); $id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644"; try { $response = $sg->client ->designs() ->_($id) ->patch($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) data = JSON.parse('{ "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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ", "generate_plain_content": false, "categories": [ "promotions" ] }') id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644" response = sg.client.designs._(id).patch(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PATCH "https://api.sendgrid.com/v3/designs/f15982c1-a82c-4e87-a6b2-a4a63b4b7644" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"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

Ahoy, World!

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

Unsubscribe - Unsubscribe Preferences

\n \n

\n \n \n ", "generate_plain_content": false, "categories": ["promotions"]}' ```