provider Designs API PATCH /designs/{id}
@utdk/sendgrid /designs/{id}
Update Design
**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": "<Updated Name>" } ```
id path required
The ID of the Design you want to duplicate.
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

putDesign
PATCH/designs/{id}
**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": "<Updated Name>" } ```

Parameters

required

The ID of the Design you want to duplicate.

Input

The list of categories applied to the design

If true, plain_content is always generated from html_content. If false, plain_content is not altered.

The HTML content of the Design.

Name of the Design.

Plain text content of the Design.

Subject of the Design.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.putDesign({
  "generate_plain_content": true,
  "name": "My Design",
  "plain_content": "<generated from html_content if left empty>"
})