--- swagger: "2.0" x-collection-name: SendGrid x-complete: 0 info: title: SendGrid Get Mail Settings Bounce Purge description: |- **This endpoint allows you to retrieve your current bounce purge settings.** This setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists. Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). version: 1.0.0 host: api.sendgrid.com basePath: /v3 schemes: - http produces: - application/json consumes: - application/json paths: /suppression/bounces: delete: summary: Delete Suppression Bounces description: "**This endpoint allows you to delete all of your bounces. You can also use this endpoint to remove a specific email address from your bounce list.**\n\nA bounced email is when the message is undeliverable and then returned to the server that sent it.\n\nFor more information see: \n\n* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information\n* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)\n* [Classroom > List Scrubbing Guide](https://sendgrid.com/docs/Classroom/Deliver/list_scrubbing.html)\n\nNote: the `delete_all` and `emails` parameters should be used independently of each other as they have different purposes." operationId: suppression.bounces.delete x-api-path-slug: suppressionbounces-delete parameters: - in: body name: body schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Email - Suppression - Bounces get: summary: Get Suppression Bounces description: "**This endpoint allows you to retrieve all of your bounces.**\n\nA bounced email is when the message is undeliverable and then returned to the server that sent it. \n\nFor more information see: \n\n* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information\n* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)" operationId: suppression.bounces.get x-api-path-slug: suppressionbounces-get parameters: - in: header name: Accept - in: query name: end_time description: Refers end of the time range in unix timestamp when a bounce was created (inclusive) - in: query name: No Name - in: query name: start_time description: Refers start of the time range in unix timestamp when a bounce was created (inclusive) responses: 200: description: OK tags: - Email - Suppression - Bounces /suppression/bounces/{email}: delete: summary: Delete Suppression Bounces Email description: "**This endpoint allows you to remove an email address from your bounce list.**\n\nA bounced email is when the message is undeliverable and then returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list. \n\nFor more information see: \n\n* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information\n* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)\n* [Classroom > List Scrubbing Guide](https://sendgrid.com/docs/Classroom/Deliver/list_scrubbing.html)" operationId: suppression.bounces.email.delete x-api-path-slug: suppressionbouncesemail-delete parameters: - in: body name: body schema: $ref: '#/definitions/holder' - in: query name: email_address description: The email address you would like to remove from the bounce list - in: query name: No Name responses: 200: description: OK tags: - Email - Suppression - Bounces - Email get: summary: Get Suppression Bounces Email description: "**This endpoint allows you to retrieve a specific bounce for a given email address.**\n\nA bounced email is when the message is undeliverable and then returned to the server that sent it.\n\nFor more information see: \n\n* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information\n* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)\n* [Classroom > List Scrubbing Guide](https://sendgrid.com/docs/Classroom/Deliver/list_scrubbing.html)" operationId: suppression.bounces.email.get x-api-path-slug: suppressionbouncesemail-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Email - Suppression - Bounces - Email /mail_settings/bounce_purge: get: summary: Get Mail Settings Bounce Purge description: |- **This endpoint allows you to retrieve your current bounce purge settings.** This setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists. Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). operationId: mail_settings.bounce_purge.get x-api-path-slug: mail-settingsbounce-purge-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Email - Mail - Settings - Bounce - Purge patch: summary: Patch Mail Settings Bounce Purge description: |- **This endpoint allows you to update your current bounce purge settings.** This setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists. Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). operationId: mail_settings.bounce_purge.patch x-api-path-slug: mail-settingsbounce-purge-patch parameters: - in: body name: body schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Email - Mail - Settings - Bounce - Purge /mail_settings/forward_bounce: get: summary: Get Mail Settings Forward Bounce description: |- **This endpoint allows you to retrieve your current bounce forwarding mail settings.** Activating this setting allows you to specify an email address to which bounce reports are forwarded. Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). operationId: mail_settings.forward_bounce.get x-api-path-slug: mail-settingsforward-bounce-get parameters: - in: query name: No Name responses: 200: description: OK tags: - Email - Mail - Settings - Forward - Bounce patch: summary: Patch Mail Settings Forward Bounce description: |- **This endpoint allows you to update your current bounce forwarding mail settings.** Activating this setting allows you to specify an email address to which bounce reports are forwarded. Mail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). operationId: mail_settings.forward_bounce.patch x-api-path-slug: mail-settingsforward-bounce-patch parameters: - in: body name: body schema: $ref: '#/definitions/holder' - in: query name: No Name responses: 200: description: OK tags: - Email - Mail - Settings - Forward - Bounce x-streamrank: polling_total_time_average: 0 polling_size_download_average: 0 streaming_total_time_average: 0 streaming_size_download_average: 0 change_yes: 0 change_no: 0 time_percentage: 0 size_percentage: 0 change_percentage: 0 last_run: "" days_run: 0 minute_run: 0 ---