{ "opencollection": "1.0.0", "info": { "name": "Twilio SendGrid Provisioning Account Bounces API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Bounces", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all bounces", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/suppression/bounces", "headers": [ { "name": "Accept", "value": "" }, { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "start_time", "value": "", "type": "query", "description": "Refers start of the time range in unix timestamp when a bounce was created (inclusive)." }, { "name": "end_time", "value": "", "type": "query", "description": "Refers end of the time range in unix timestamp when a bounce was created (inclusive)." }, { "name": "limit", "value": "", "type": "query", "description": "`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page." }, { "name": "offset", "value": "", "type": "query", "description": "The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0` represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the `offset` to the page size as determined by `limit`. Use multiples of the page size as your `offset` to request further consecutive pages. E.g. assume your page size is set to `10`. An `offset` of `10` requests the second page, an `offset` of `20` requests the third page and so on, provided there are sufficiently many items in your list." }, { "name": "email", "value": "", "type": "query", "description": "Specifies which records to return based on the records' associated email addresses. For example, `sales` returns records with email addresses that start with 'sales', such as `salesdepartment@example.com` or `sales@example.com`. You can also use `%25` as a wildcard. For example, `%25market` returns records containing email addresses with the string 'market' anywhere in the email address, and `%25market%25tree` returns records containing email addresses with the string 'market' followed by the string 'tree'. Any reserved characters should be [percent-encoded](https://en.wikipedia.org/wiki/Percent-encoding#Reserved_characters), e.g., the `@` symbol should be encoded as `%40`." } ] }, "docs": "**This endpoint allows you to retrieve a paginated list of all your bounces.**\n\nYou can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items." }, { "info": { "name": "Delete bounces", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/suppression/bounces", "headers": [ { "name": "on-behalf-of", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint allows you to delete all emails on your bounces list.**\n\nThere are two options for deleting bounced emails: \n\n1. You can delete all bounced emails by setting `delete_all` to `true` in the request body. \n2. You can delete a selection of bounced emails by specifying the email addresses in the `emails` array of the request body. \n\n**WARNING:** You can not have both `emails` and `delete_all` set." }, { "info": { "name": "Retrieve a Bounce", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/suppression/bounces/:email", "headers": [ { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "email", "value": "", "type": "path", "description": "The email address of the specific bounce you would like to retrieve" } ] }, "docs": "**This endpoint allows you to retrieve a specific bounce by email address.**" }, { "info": { "name": "Delete a bounce", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.sendgrid.com/v3/suppression/bounces/:email", "headers": [ { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "email", "value": "", "type": "path", "description": "The email address you would like to remove from the bounce list." } ] }, "docs": "**This endpoint allows you to remove an email address from your bounce list.**" }, { "info": { "name": "Retrieve bounce classification totals", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/suppression/bounces/classifications", "headers": [ { "name": "Accept", "value": "" }, { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)." }, { "name": "end_date", "value": "", "type": "query", "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)." } ] }, "docs": "This endpoint will return the total number of bounces by classification in descending order for each day. You can retrieve the bounce classification totals in CSV format by specifying `\"text/csv\"` in the Accept header." }, { "info": { "name": "Retrieve bounce classification over time by domain stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.sendgrid.com/v3/suppression/bounces/classifications/:classification", "headers": [ { "name": "Accept", "value": "" }, { "name": "on-behalf-of", "value": "" } ], "params": [ { "name": "classification", "value": "", "type": "path", "description": "The classification you want to filter by. Possible values are: `Content`, `Frequency or Volume Too High`, `Invalid Address`, `Mailbox Unavailable`, `Reputation`, `Technical Failure`, `Unclassified`." }, { "name": "start_date", "value": "", "type": "query", "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)." }, { "name": "end_date", "value": "", "type": "query", "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)." } ] }, "docs": "This endpoint will return the number of bounces for the classification specified in descending order for each day. You can retrieve the bounce classification totals in CSV format by specifying `\"text/csv\"` in the Accept header." } ] } ], "bundled": true }