{ "opencollection": "1.0.0", "info": { "name": "Twilio SendGrid Provisioning Account Single Sends API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Single Sends", "type": "folder" }, "items": [ { "info": { "name": "Get All Single Sends", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/marketing/singlesends", "params": [ { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" } ] }, "docs": "**This endpoint allows you to retrieve all your Single Sends.**\n\nReturns all of your Single Sends with condensed details about each, including the Single Sends' IDs. For more details about an individual Single Send, pass the Single Send's ID to the `/marketing/singlesends/{id}` endpoint." }, { "info": { "name": "Create Single Send", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/marketing/singlesends", "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to create a new Single Send.**\n\nPlease note that if you are migrating from the previous version of Single Sends, you no longer need to pass a template ID with your request to this endpoint. Instead, you will pass all template data in the `email_config` object.\n\nThis endpoint will create a draft of the Single Send but will not send it or schedule it to be sent. Any `send_at` property value set with this endpoint will prepopulate the Single Send's send date. However, the" }, { "info": { "name": "Bulk Delete Single Sends", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/marketing/singlesends", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Single Send IDs to delete" } ] }, "docs": "**This endpoint allows you to delete multiple Single Sends using an array of Single Sends IDs.**\n\nTo first retrieve all your Single Sends' IDs, you can make a GET request to the `/marketing/singlensends` endpoint.\n\nPlease note that a DELETE request is permanent, and your Single Sends will not be recoverable after deletion." }, { "info": { "name": "Get Single Send by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/marketing/singlesends/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**This endpoint allows you to retrieve details about one Single Send using a Single Send ID.**\n\nYou can retrieve all of your Single Sends by making a GET request to the `/marketing/singlesends` endpoint." }, { "info": { "name": "Duplicate Single Send", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/marketing/singlesends/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to duplicate an existing Single Send using its Single Send ID.**\n\nDuplicating a Single Send is useful when you want to create a Single Send but don't want to start from scratch. Once duplicated, you can update or edit the Single Send by making a PATCH request to the `/marketing/singlesends/{id}` endpoint.\n \nIf you leave the `name` field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text “Copy of ” prepended to it. The `n" }, { "info": { "name": "Update Single Send", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.sendgrid.com/v3/marketing/singlesends/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to update a Single Send using a Single Send ID.**\n\nYou only need to pass the properties you want to update. Any blank or missing properties will remain unaltered.\n\nThis endpoint will update a draft of the Single Send but will not send it or schedule it to be sent. Any `send_at` property value set with this endpoint will prepopulate the Single Send's send date. However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send*" }, { "info": { "name": "Delete Single Send by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/marketing/singlesends/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**This endpoint allows you to delete one Single Send using a Single Send ID.**\n\nTo first retrieve all your Single Sends' IDs, you can make a GET request to the `/marketing/singlensends` endpoint.\n\nPlease note that a `DELETE` request is permanent, and your Single Send will not be recoverable after deletion." }, { "info": { "name": "Schedule Single Send", "type": "http" }, "http": { "method": "PUT", "url": "https://api.sendgrid.com/v3/marketing/singlesends/:id/schedule", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to send a Single Send immediately or schedule it to be sent at a later time.**\n\nTo send your message immediately, set the `send_at` property value to the string `now`. To schedule the Single Send for future delivery, set the `send_at` value to your desired send time in [ISO 8601 date time format](https://www.iso.org/iso-8601-date-and-time-format.html) (`yyyy-MM-ddTHH:mm:ssZ`)." }, { "info": { "name": "Delete Single Send Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/marketing/singlesends/:id/schedule", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**This endpoint allows you to cancel a scheduled Single Send using a Single Send ID.**\n\nMaking a DELETE request to this endpoint will cancel the scheduled sending of a Single Send. The request will not delete the Single Send itself. Deleting a Single Send can be done by passing a DELETE request to `/marketing/singlesends/{id}`." }, { "info": { "name": "Get All Categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/marketing/singlesends/categories" }, "docs": "**This endpoint allows you to retrieve all the categories associated with your Single Sends.**\n\nThis endpoint will return your latest 1,000 categories." }, { "info": { "name": "Get Single Sends Search", "type": "http" }, "http": { "method": "POST", "url": "https://api.sendgrid.com/v3/marketing/singlesends/search", "params": [ { "name": "page_size", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to search for Single Sends based on specified criteria.**\n\nYou can search for Single Sends by passing a combination of values using the `name`, `status`, and `categories` request body fields.\n\nFor example, if you want to search for all Single Sends that are \"drafts\" or \"scheduled\" and also associated with the category \"shoes,\" your request body may look like the example below.\n\n```javascript\n{\n \"status\": [\n \"draft\",\n \"scheduled\"\n ],\n \"categories\": [\n \"shoes" } ] } ], "bundled": true }