{ "opencollection": "1.0.0", "info": { "name": "Twilio SendGrid Provisioning Account Designs API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Designs", "type": "folder" }, "items": [ { "info": { "name": "List Designs", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/designs", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "number of results to return" }, { "name": "page_token", "value": "", "type": "query", "description": "token corresponding to a specific page of results, as provided by metadata" }, { "name": "summary", "value": "", "type": "query", "description": "set to false to return all fields" } ] }, "docs": "**This endpoint allows you to retrieve a list of designs already stored in your Design Library**.\n\nA 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.\n\nBy 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 " }, { "info": { "name": "Create Design", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/designs", "body": { "type": "json", "data": "{}" } }, "docs": "**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’s HTML elements into drag and drop modules t" }, { "info": { "name": "Get Design", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the Design you want to duplicate." } ] }, "docs": "**This endpoint allows you to retrieve a single design**.\n\nA GET request to `/designs/{id}` will retrieve details about a specific design in your Design Library.\n\nThis endpoint is valuable when retrieving information stored in a field that you wish to update using a PATCH request." }, { "info": { "name": "Duplicate Design", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the Design you want to duplicate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**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 different" }, { "info": { "name": "Update Design", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.sendgrid.com/v3/designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the Design you want to duplicate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**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```" }, { "info": { "name": "Delete Design", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the Design you want to duplicate." } ] }, "docs": "**This endpoint allows you to delete a single design**.\n\nBe sure to check the ID of the design you intend to delete before making this request; deleting a design is a permanent action." }, { "info": { "name": "List SendGrid Pre-built Designs", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/designs/pre-builts", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "number of results to return" }, { "name": "page_token", "value": "", "type": "query", "description": "token corresponding to a specific page of results, as provided by metadata" }, { "name": "summary", "value": "", "type": "query", "description": "set to false to return all fields" } ] }, "docs": "**This endpoint allows you to retrieve a list of pre-built designs provided by Twilio SendGrid**.\n\nUnlike 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.\n\nBy 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 p" }, { "info": { "name": "Get SendGrid Pre-built Design", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/designs/pre-builts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the pre-built Design you want to duplicate." } ] }, "docs": "**This endpoint allows you to retrieve a single pre-built design**.\n\nA GET request to `/designs/pre-builts/{id}` will retrieve details about a specific pre-built design.\n\nThis endpoint is valuable when retrieving details about a pre-built design that you wish to duplicate and modify." }, { "info": { "name": "Duplicate SendGrid Pre-built Design", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/designs/pre-builts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the pre-built Design you want to duplicate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to duplicate one of the pre-built Twilio SendGrid designs**.\n\nLike 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 f" } ] } ], "bundled": true }