{ "info": { "_postman_id": "7be5356f-496f-4690-836f-43c0215f0f7f", "name": "Twilio SendGrid Suppressions API", "description": "The Twilio SendGrid Suppressions API allows you to manage your Suppressions or Unsubscribes and Suppression or Unsubscribe groups. With SendGrid, an unsubscribe is the action an email recipient takes when they opt-out of receiving your messages. A suppression is the action you take as a sender to filter or suppress an unsubscribed address from your email send. From the perspective of the recipient, your suppression is the result of their unsubscribe.\n\nYou can have global suppressions, which represent addresses that have been unsubscribed from all of your emails. You can also have suppression groups, also known as ASM groups, which represent categories or groups of emails that your recipients can unsubscribe from, rather than unsubscribing from all of your messages.\n\nSendGrid automatically suppresses emails sent to users for a variety of reasons, including blocks, bounces, invalid email addresses, spam reports, and unsubscribes. SendGrid suppresses these messages to help you maintain the best possible sender reputation by attempting to prevent unwanted mail. You may also add addresses to your suppressions.\n\nSee [**Suppressions**](https://docs.sendgrid.com/for-developers/sending-email/suppressions) for more information.\n\nContact Support:\n Name: Twilio SendGrid Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:17:50.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "lastUpdatedBy": "35240", "uid": "35240-7be5356f-496f-4690-836f-43c0215f0f7f" }, "item": [ { "name": "v3", "item": [ { "name": "asm", "item": [ { "name": "groups", "item": [ { "name": "{group_id}", "item": [ { "name": "suppressions", "item": [ { "name": "{email}", "item": [ { "name": "Delete a suppression from a suppression group", "id": "54c1dd61-e5ba-44e9-b54b-4a9569cbb8e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions", ":email" ], "variable": [ { "id": "105a82cc-af61-45bb-b258-24db0228d81a", "key": "group_id", "value": "", "description": "(Required) The id of the suppression group that you are removing an email address from." }, { "id": "e5fb6868-e28a-4233-a75e-b8042f878810", "key": "email", "value": "", "description": "(Required) The email address that you want to remove from the suppression group." } ] }, "description": "**This endpoint allows you to remove a suppressed email address from the given suppression group.**\n\nRemoving an address will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required." }, "response": [ { "id": "685cf24e-e94f-4072-b98f-19e8a40153d9", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions", ":email" ], "variable": [ { "key": "group_id" }, { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-685cf24e-e94f-4072-b98f-19e8a40153d9" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-54c1dd61-e5ba-44e9-b54b-4a9569cbb8e3" } ], "id": "4a9e0a78-bca4-4c07-9151-14c2cbc654de", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-4a9e0a78-bca4-4c07-9151-14c2cbc654de" }, { "name": "search", "item": [ { "name": "Search for suppressions within a group", "id": "99c4de0d-e401-43f4-933c-0f7e95b399ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions/search", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions", "search" ], "variable": [ { "id": "904d6a4f-ee9f-4ddf-82d6-bf5d223e6f7f", "key": "group_id", "value": "", "description": "(Required) The ID of the suppression group that you would like to search." } ] }, "description": "**This endpoint allows you to search a suppression group for multiple suppressions.**\n\nWhen given a list of email addresses and a group ID, this endpoint will only return the email addresses that have been unsubscribed from the given group." }, "response": [ { "id": "5a57b1be-1447-4d51-9c22-46b2107fc233", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions/search", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions", "search" ], "variable": [ { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n \"\",\n \"\"\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-5a57b1be-1447-4d51-9c22-46b2107fc233" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-99c4de0d-e401-43f4-933c-0f7e95b399ff" } ], "id": "703a8d63-210b-40bf-bcfb-5403b2f12031", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-703a8d63-210b-40bf-bcfb-5403b2f12031" }, { "name": "Add suppressions to a suppression group", "id": "cb665852-5d39-4afd-af09-a5bec544c83d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions" ], "variable": [ { "id": "4df76967-7bcd-413a-8f10-9fe76e07bf1e", "key": "group_id", "value": "", "description": "(Required) The id of the unsubscribe group that you are adding suppressions to." } ] }, "description": "**This endpoint allows you to add email addresses to an unsubscribe group.**\n\nIf you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list." }, "response": [ { "id": "953153d7-5817-4058-8c54-6f7a6bd17737", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions" ], "variable": [ { "key": "group_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-953153d7-5817-4058-8c54-6f7a6bd17737" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-cb665852-5d39-4afd-af09-a5bec544c83d" }, { "name": "Retrieve all suppressions for a suppression group", "id": "04b4a55e-3534-4a7e-8430-49f41c43c5fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions" ], "variable": [ { "id": "983c6d5d-7e87-43c0-93aa-95d36154b949", "key": "group_id", "value": "", "description": "(Required) The id of the unsubscribe group that you are adding suppressions to." } ] }, "description": "**This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**" }, "response": [ { "id": "2fde717a-e767-4baa-9930-48c77c9469c1", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id", "suppressions" ], "variable": [ { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n \"\",\n \"\"\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-2fde717a-e767-4baa-9930-48c77c9469c1" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-04b4a55e-3534-4a7e-8430-49f41c43c5fe" } ], "id": "08b91086-0460-498c-b99c-be1b0006cf77", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-08b91086-0460-498c-b99c-be1b0006cf77" }, { "name": "Get information on a single suppression group.", "id": "b44fa110-a618-4ce9-ae5c-7c5d1c9b1cc7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id" ], "variable": [ { "id": "d91fc18f-de5b-48e0-8c1c-103ecd1e348c", "key": "group_id", "value": "", "description": "(Required) The ID of the suppression group you would like to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a single suppression group.**" }, "response": [ { "id": "1c8b7bc4-d505-422d-bf21-77fe7a2e21bb", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": \"\",\n \"unsubscribes\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-1c8b7bc4-d505-422d-bf21-77fe7a2e21bb" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-b44fa110-a618-4ce9-ae5c-7c5d1c9b1cc7" }, { "name": "Update a suppression group.", "id": "d9cb8808-cd37-40f6-94dd-52cee33423f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id" ], "variable": [ { "id": "71b336da-4255-4200-b8dc-4685f4c0e460", "key": "group_id", "value": "", "description": "(Required) The ID of the suppression group you would like to retrieve." } ] }, "description": "**This endpoint allows you to update or change a suppression group.**" }, "response": [ { "id": "6d0908b6-80cd-4710-b340-dec116830bc3", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": false,\n \"unsubscribes\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-6d0908b6-80cd-4710-b340-dec116830bc3" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-d9cb8808-cd37-40f6-94dd-52cee33423f5" }, { "name": "Delete a Suppression Group", "id": "2b80ad8f-761e-4a8d-bcce-2afa3c911cd0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id" ], "variable": [ { "id": "5167fd09-87f2-43a6-a4cf-6db4383fcd59", "key": "group_id", "value": "", "description": "(Required) The ID of the suppression group you would like to retrieve." } ] }, "description": "**This endpoint allows you to delete a suppression group.**\n\nIf a recipient uses the \"one-click unsubscribe\" option on an email associated with a deleted group, that recipient will be added to the global suppression list.\n\nDeleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required." }, "response": [ { "id": "5912b78e-4ed7-4c14-af78-ef0ae0092921", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-5912b78e-4ed7-4c14-af78-ef0ae0092921" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-2b80ad8f-761e-4a8d-bcce-2afa3c911cd0" } ], "id": "80139ea2-4b22-4d38-8395-588ce1bf8f64", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-80139ea2-4b22-4d38-8395-588ce1bf8f64" }, { "name": "Create a new suppression group", "id": "3abd2555-b179-4b47-bedb-21308039f9b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups" ] }, "description": "**This endpoint allows you to create a new suppression group.**\n\nTo add an email address to the suppression group, [create a Suppression](https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-group)." }, "response": [ { "id": "7d08feff-3693-47e2-90b7-0f4f5d9cb6d1", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/groups", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-7d08feff-3693-47e2-90b7-0f4f5d9cb6d1" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-3abd2555-b179-4b47-bedb-21308039f9b2" }, { "name": "Retrieve all suppression groups associated with the user.", "id": "103e7bc1-b672-4911-ad0c-39d1efa95b70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups?id=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups" ], "query": [ { "description": "The ID of the suppression group(s) you want to retrieve.", "key": "id", "value": "" } ] }, "description": "**This endpoint allows you to retrieve a list of all suppression groups created by this user.**\n\nThis endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append `?id=123456&id=123456`, with the appropriate group IDs." }, "response": [ { "id": "45323135-4ff0-4677-9cee-605ac6887def", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/groups?id=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "groups" ], "query": [ { "description": "The ID of the suppression group(s) you want to retrieve.", "key": "id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": false,\n \"unsubscribes\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"is_default\": false,\n \"unsubscribes\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-45323135-4ff0-4677-9cee-605ac6887def" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-103e7bc1-b672-4911-ad0c-39d1efa95b70" } ], "id": "edc6c715-1420-433b-a887-07d8cba93902", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-edc6c715-1420-433b-a887-07d8cba93902" }, { "name": "suppressions", "item": [ { "name": "{email}", "item": [ { "name": "Retrieve all suppression groups for an email address", "id": "f23973b4-8341-473c-bf6a-6218e1d43f15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", ":email" ], "variable": [ { "id": "951f044d-d972-4574-92dd-b2552e23661a", "key": "email", "value": "", "description": "(Required) The email address that you want to search suppression groups for." } ] }, "description": "**This endpoint returns a list of all groups from which the given email address has been unsubscribed.**" }, "response": [ { "id": "841c00b0-824c-4a62-960d-f415ced5e79b", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"suppressions\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"suppressed\": \"\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"is_default\": \"\",\n \"name\": \"\",\n \"suppressed\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-841c00b0-824c-4a62-960d-f415ced5e79b" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-f23973b4-8341-473c-bf6a-6218e1d43f15" } ], "id": "fad24594-2beb-4e5f-8b9e-054802712426", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-fad24594-2beb-4e5f-8b9e-054802712426" }, { "name": "global", "item": [ { "name": "{email}", "item": [ { "name": "Retrieve a Global Suppression", "id": "26c86cf2-31e0-4677-8be3-9ff69f9a8446", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/global/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", "global", ":email" ], "variable": [ { "id": "d231e2e1-dc67-4747-a11e-13b50d6b519e", "key": "email", "value": "", "description": "(Required) The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global suppressions list, enter that email address here." } ] }, "description": "**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.**\n\nIf the email address you include in the URL path parameter `{email}` is already globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned." }, "response": [ { "id": "7fd233d5-0d35-4568-bee2-ed36535ecbaa", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/global/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", "global", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipient_email\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-7fd233d5-0d35-4568-bee2-ed36535ecbaa" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-26c86cf2-31e0-4677-8be3-9ff69f9a8446" }, { "name": "Delete a Global Suppression", "id": "79b53619-4088-46d0-942f-d1fd8cbf135b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/global/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", "global", ":email" ], "variable": [ { "id": "75101407-1d3a-4bca-9477-d58bddcc0dea", "key": "email", "value": "", "description": "(Required) The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global suppressions list, enter that email address here." } ] }, "description": "**This endpoint allows you to remove an email address from the global suppressions group.**\n\nDeleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required." }, "response": [ { "id": "3d0470e8-5b53-4298-9507-7ca092653029", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/global/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", "global", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-3d0470e8-5b53-4298-9507-7ca092653029" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-79b53619-4088-46d0-942f-d1fd8cbf135b" } ], "id": "3a49c281-577e-4ff4-87a0-8151b9d0a7a5", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-3a49c281-577e-4ff4-87a0-8151b9d0a7a5" }, { "name": "Add recipient addresses to the global suppression group.", "id": "2b1de42a-4f64-4c86-bbe5-9f6d9743f69a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/global", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", "global" ] }, "description": "**This endpoint allows you to add one or more email addresses to the global suppressions group.**" }, "response": [ { "id": "4463111f-7480-4c33-a659-10b96da3f06c", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/asm/suppressions/global", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions", "global" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recipient_emails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-4463111f-7480-4c33-a659-10b96da3f06c" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-2b1de42a-4f64-4c86-bbe5-9f6d9743f69a" } ], "id": "ce8fbfeb-1260-4fb3-b472-ff0f76fba278", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-ce8fbfeb-1260-4fb3-b472-ff0f76fba278" }, { "name": "Retrieve all suppressions", "id": "233e7f87-97cb-41c4-80bb-d5787b6e1d0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions" ] }, "description": "**This endpoint allows you to retrieve a list of all suppressions.**" }, "response": [ { "id": "dd3688c1-353e-414b-9b42-3f49de1e1e2d", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/asm/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "v3", "asm", "suppressions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"email\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"created_at\": \"\"\n },\n {\n \"email\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"created_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-dd3688c1-353e-414b-9b42-3f49de1e1e2d" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-233e7f87-97cb-41c4-80bb-d5787b6e1d0c" } ], "id": "bf589641-66e2-43d7-b316-4ccdf30ebd6b", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-bf589641-66e2-43d7-b316-4ccdf30ebd6b" } ], "id": "9afb12a6-32f6-4d9f-9ae0-d56731055e9f", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-9afb12a6-32f6-4d9f-9ae0-d56731055e9f" }, { "name": "suppression", "item": [ { "name": "blocks", "item": [ { "name": "{email}", "item": [ { "name": "Retrieve a specific block", "id": "8fef79f6-bf45-4373-9c20-2d3b45c82962", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/blocks/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks", ":email" ], "variable": [ { "id": "1bb1be06-6f34-4cbd-ad2f-9852409f8c6d", "key": "email", "value": "", "description": "(Required) The email address of the specific block." } ] }, "description": "**This endpoint allows you to retrieve a specific email address from your blocks list.**" }, "response": [ { "id": "dd8e1b8d-8246-4e7e-b64f-fc6d13c04473", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/blocks/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-dd8e1b8d-8246-4e7e-b64f-fc6d13c04473" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-8fef79f6-bf45-4373-9c20-2d3b45c82962" }, { "name": "Delete a specific block", "id": "fe9b04bc-30f8-4b7b-bde6-43c001e2d1e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/blocks/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks", ":email" ], "variable": [ { "id": "c3f18d19-395c-47a1-ac3f-9c0f18537729", "key": "email", "value": "", "description": "(Required) The email address of the specific block." } ] }, "description": "**This endpoint allows you to delete a specific email address from your blocks list.**" }, "response": [ { "id": "22c1bfc7-216e-43ba-b92a-15080ce9e835", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/blocks/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-22c1bfc7-216e-43ba-b92a-15080ce9e835" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-fe9b04bc-30f8-4b7b-bde6-43c001e2d1e7" } ], "id": "fdf408d9-17c9-492c-a806-423f77004d22", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-fdf408d9-17c9-492c-a806-423f77004d22" }, { "name": "Retrieve all blocks", "id": "79153eea-0f93-4cf4-97e0-1008646d0552", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/blocks?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks" ], "query": [ { "description": "The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.", "key": "start_time", "value": "" }, { "description": "The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] }, "description": "**This endpoint allows you to retrieve a paginated list of all email addresses that are currently on your blocks list.**\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." }, "response": [ { "id": "7a03257f-97cf-4ec2-9899-16cd8e3c34be", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/blocks?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks" ], "query": [ { "description": "The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.", "key": "start_time", "value": "" }, { "description": "The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-7a03257f-97cf-4ec2-9899-16cd8e3c34be" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-79153eea-0f93-4cf4-97e0-1008646d0552" }, { "name": "Delete blocks", "id": "563e5bcc-183a-4d04-a313-5cb5794b0194", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/blocks", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks" ] }, "description": "**This endpoint allows you to delete all email addresses on your blocks list.**\n\nThere are two options for deleting blocked emails: \n\n1. You can delete all blocked emails by setting `delete_all` to `true` in the request body. \n2. You can delete a selection of blocked emails by specifying the email addresses in the `emails` array of the request body." }, "response": [ { "id": "cf8590be-b079-4cae-9529-6f20d575b060", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/blocks", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "blocks" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-cf8590be-b079-4cae-9529-6f20d575b060" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-563e5bcc-183a-4d04-a313-5cb5794b0194" } ], "id": "ca841e75-fd21-45d7-a8c4-536d5707190d", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-ca841e75-fd21-45d7-a8c4-536d5707190d" }, { "name": "bounces", "item": [ { "name": "{email}", "item": [ { "name": "Retrieve a Bounce", "id": "d9796f41-8cff-4e1d-a340-da26a89f98d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", ":email" ], "variable": [ { "id": "9ac18797-695a-4e04-b3d9-312892edbdc2", "key": "email", "value": "", "description": "(Required) The email address of the specific bounce you would like to retrieve" } ] }, "description": "**This endpoint allows you to retrieve a specific bounce by email address.**" }, "response": [ { "id": "136c4685-8003-452d-8cd2-2221cdac67a3", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-136c4685-8003-452d-8cd2-2221cdac67a3" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-d9796f41-8cff-4e1d-a340-da26a89f98d7" }, { "name": "Delete a bounce", "id": "00fdedfe-4f8b-4100-8a6e-0c4e9a44a988", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", ":email" ], "variable": [ { "id": "9574c8fc-6300-4425-87c5-84c0b78e87d7", "key": "email", "value": "", "description": "(Required) The email address you would like to remove from the bounce list." } ] }, "description": "**This endpoint allows you to remove an email address from your bounce list.**" }, "response": [ { "id": "e0db519a-c072-4096-a8a3-edcbff564231", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-e0db519a-c072-4096-a8a3-edcbff564231" }, { "id": "c41c670b-30cb-444e-975e-d6b3d07b381c", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-c41c670b-30cb-444e-975e-d6b3d07b381c" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-00fdedfe-4f8b-4100-8a6e-0c4e9a44a988" } ], "id": "d66e05e6-369e-434c-8a90-d40c141076d9", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-d66e05e6-369e-434c-8a90-d40c141076d9" }, { "name": "classifications", "item": [ { "name": "{classification}", "item": [ { "name": "Retrieve bounce classification over time by domain stats", "id": "56c4f32f-7f43-45ff-bac1-01e5e9480589", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/classifications/:classification?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", "classifications", ":classification" ], "query": [ { "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "start_date", "value": "" }, { "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "end_date", "value": "" } ], "variable": [ { "id": "7acd238c-b7b9-46f9-ae44-8db7801eb286", "key": "classification", "value": "Technical Failure", "description": "(Required) The classification you want to filter by. Possible values are: `Content`, `Frequency or Volume Too High`, `Invalid Address`, `Mailbox Unavailable`, `Reputation`, `Technical Failure`, `Unclassified`." } ] }, "description": "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." }, "response": [ { "id": "01f0c9ea-391b-4bb8-b30e-0fc3d277e141", "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/classifications/:classification?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", "classifications", ":classification" ], "query": [ { "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "start_date", "value": "" }, { "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "end_date", "value": "" } ], "variable": [ { "key": "classification" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": [\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"domain\": \"\",\n \"count\": \"\"\n },\n {\n \"domain\": \"\",\n \"count\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"domain\": \"\",\n \"count\": \"\"\n },\n {\n \"domain\": \"\",\n \"count\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-01f0c9ea-391b-4bb8-b30e-0fc3d277e141" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-56c4f32f-7f43-45ff-bac1-01e5e9480589" } ], "id": "f38be2a7-519c-4210-af0e-b30f3cb6b65e", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-f38be2a7-519c-4210-af0e-b30f3cb6b65e" }, { "name": "Retrieve bounce classification totals", "id": "6a26105d-d019-42ea-89b5-cac0f23a821e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/classifications?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", "classifications" ], "query": [ { "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "start_date", "value": "" }, { "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "end_date", "value": "" } ] }, "description": "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." }, "response": [ { "id": "a42135af-6d08-4d4c-955f-cd77301f7a13", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/classifications?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", "classifications" ], "query": [ { "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "start_date", "value": "" }, { "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "end_date", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": [\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"classification\": \"Invalid Address\",\n \"count\": \"\"\n },\n {\n \"classification\": \"Frequency or Volume Too High\",\n \"count\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"classification\": \"Content\",\n \"count\": \"\"\n },\n {\n \"classification\": \"Invalid Address\",\n \"count\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-a42135af-6d08-4d4c-955f-cd77301f7a13" }, { "id": "9608ef99-16a4-4194-ae35-18a4f4c15823", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces/classifications?start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces", "classifications" ], "query": [ { "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "start_date", "value": "" }, { "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).", "key": "end_date", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-9608ef99-16a4-4194-ae35-18a4f4c15823" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-6a26105d-d019-42ea-89b5-cac0f23a821e" } ], "id": "f0fc6afe-5b26-4254-9521-ef3fa005cf37", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-f0fc6afe-5b26-4254-9521-ef3fa005cf37" }, { "name": "Retrieve all bounces", "id": "e8ba20e9-b1b2-4022-a1ac-4efa56f42b0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces" ], "query": [ { "description": "Refers start of the time range in unix timestamp when a bounce was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when a bounce was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] }, "description": "**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." }, "response": [ { "id": "095ee8f1-fc77-4be2-8e89-005777cdaa5d", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces" ], "query": [ { "description": "Refers start of the time range in unix timestamp when a bounce was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when a bounce was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\",\n \"status\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-095ee8f1-fc77-4be2-8e89-005777cdaa5d" }, { "id": "3e3f97a7-8a58-4e4e-beb2-82b30eeeb00f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/bounces?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces" ], "query": [ { "description": "Refers start of the time range in unix timestamp when a bounce was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when a bounce was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-3e3f97a7-8a58-4e4e-beb2-82b30eeeb00f" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-e8ba20e9-b1b2-4022-a1ac-4efa56f42b0a" }, { "name": "Delete bounces", "id": "15519ea3-a137-42a5-a695-ecbcf69781fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/bounces", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces" ] }, "description": "**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." }, "response": [ { "id": "49d2688a-5c50-4cc9-aefc-a601bf980b87", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/bounces", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-49d2688a-5c50-4cc9-aefc-a601bf980b87" }, { "id": "90fa9a45-ea86-4176-a7da-3d8f8993b7fb", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/bounces", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "bounces" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-90fa9a45-ea86-4176-a7da-3d8f8993b7fb" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-15519ea3-a137-42a5-a695-ecbcf69781fe" } ], "id": "17d267f1-b5fe-4913-a6d4-c9c471629ef3", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-17d267f1-b5fe-4913-a6d4-c9c471629ef3" }, { "name": "invalid_emails", "item": [ { "name": "{email}", "item": [ { "name": "Retrieve a specific invalid email", "id": "095f6ea3-7cce-49a1-9b2e-25b0aec586d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails", ":email" ], "variable": [ { "id": "ab74cef2-2760-442c-b1ee-12aafcc8fa21", "key": "email", "value": "", "description": "(Required) The specific email address of the invalid email entry that you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a specific invalid email addresses.**" }, "response": [ { "id": "5cb68a1a-36f9-4aee-ab28-861884652f62", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-5cb68a1a-36f9-4aee-ab28-861884652f62" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-095f6ea3-7cce-49a1-9b2e-25b0aec586d9" }, { "name": "Delete a specific invalid email", "id": "f39cd379-7404-46d9-831e-6dfa15e0e2b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails", ":email" ], "variable": [ { "id": "7747ac6a-ec62-4c46-ae6e-c25006ae50b9", "key": "email", "value": "", "description": "(Required) The specific email address of the invalid email entry that you want to retrieve." } ] }, "description": "**This endpoint allows you to remove a specific email address from the invalid email address list.**" }, "response": [ { "id": "415e425c-f225-4454-a9bb-271d25fbdeca", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-415e425c-f225-4454-a9bb-271d25fbdeca" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-f39cd379-7404-46d9-831e-6dfa15e0e2b2" } ], "id": "07459c9d-4c0c-41be-9e4c-8b1fcfa24693", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-07459c9d-4c0c-41be-9e4c-8b1fcfa24693" }, { "name": "Retrieve all invalid emails", "id": "8e21b8da-4b50-4b4c-a3cc-3b4174ffb69a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails" ], "query": [ { "description": "Refers start of the time range in unix timestamp when an invalid email was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when an invalid email was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "description": "This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be returned.", "key": "email", "value": "" } ] }, "description": "**This endpoint allows you to retrieve a paginated list of all invalid email addresses.**\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." }, "response": [ { "id": "0939088d-9fd7-4d8a-b291-7da69cfc12bb", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails" ], "query": [ { "description": "Refers start of the time range in unix timestamp when an invalid email was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when an invalid email was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "description": "This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be returned.", "key": "email", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"reason\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-0939088d-9fd7-4d8a-b291-7da69cfc12bb" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-8e21b8da-4b50-4b4c-a3cc-3b4174ffb69a" }, { "name": "Delete invalid emails", "id": "91cc3e0f-0bac-4692-bbe6-c022b74292b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails" ] }, "description": "**This endpoint allows you to remove email addresses from your invalid email address list.**\n\nThere are two options for deleting invalid email addresses: \n\n1) You can delete all invalid email addresses by setting `delete_all` to true in the request body.\n2) You can delete some invalid email addresses by specifying certain addresses in an array in the request body." }, "response": [ { "id": "5523e8bb-e447-49ed-b7de-faa7a592286c", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/invalid_emails", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "invalid_emails" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-5523e8bb-e447-49ed-b7de-faa7a592286c" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-91cc3e0f-0bac-4692-bbe6-c022b74292b2" } ], "id": "7e7485ae-ac27-4b86-8e45-bbaf9e1761f2", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-7e7485ae-ac27-4b86-8e45-bbaf9e1761f2" }, { "name": "spam_reports", "item": [ { "name": "{email}", "item": [ { "name": "Retrieve a specific spam report", "id": "81406019-7cbc-4a46-a9d6-0afc0c1ad76f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports", ":email" ], "variable": [ { "id": "a9e3187c-f90d-4fe8-a953-1a88faf60131", "key": "email", "value": "", "description": "(Required) The email address of a specific spam report that you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a specific spam report by email address.**" }, "response": [ { "id": "6e25f30c-ee28-4d75-864d-6a0a2c74942a", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"ip\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"ip\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-6e25f30c-ee28-4d75-864d-6a0a2c74942a" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-81406019-7cbc-4a46-a9d6-0afc0c1ad76f" }, { "name": "Delete a specific spam report", "id": "1e4bf7dc-c042-4318-8dc1-ebb16243491a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports", ":email" ], "variable": [ { "id": "08f89480-b520-4a88-9521-aa5705b9f5df", "key": "email", "value": "", "description": "(Required) The email address of a specific spam report that you want to retrieve." } ] }, "description": "**This endpoint allows you to delete a specific spam report by email address.**\n\nDeleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required." }, "response": [ { "id": "4ce4f68f-d3bd-4eda-84a9-da7a62bddc32", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports/:email", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports", ":email" ], "variable": [ { "key": "email" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-4ce4f68f-d3bd-4eda-84a9-da7a62bddc32" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-1e4bf7dc-c042-4318-8dc1-ebb16243491a" } ], "id": "043acebd-645e-44d6-b98f-bbd205b59b0b", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-043acebd-645e-44d6-b98f-bbd205b59b0b" }, { "name": "Retrieve all spam reports", "id": "ec002e6c-64b3-4b91-92ec-95a4d88d8847", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports" ], "query": [ { "description": "The start of the time range when a spam report was created (inclusive). This is a unix timestamp.", "key": "start_time", "value": "" }, { "description": "The end of the time range when a spam report was created (inclusive). This is a unix timestamp.", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] }, "description": "**This endpoint allows you to retrieve a paginated list of all spam reports.**\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." }, "response": [ { "id": "376bd7d6-bf2e-4d8b-9da0-642b519a4097", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports" ], "query": [ { "description": "The start of the time range when a spam report was created (inclusive). This is a unix timestamp.", "key": "start_time", "value": "" }, { "description": "The end of the time range when a spam report was created (inclusive). This is a unix timestamp.", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\",\n \"ip\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\",\n \"ip\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-376bd7d6-bf2e-4d8b-9da0-642b519a4097" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-ec002e6c-64b3-4b91-92ec-95a4d88d8847" }, { "name": "Delete spam reports", "id": "6e77ccc3-b4e7-4f06-a2f2-0a3a589501dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports" ] }, "description": "**This endpoint allows you to delete your spam reports.**\n\nDeleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required.\n\nThere are two options for deleting spam reports: \n\n1. You can delete all spam reports by setting the `delete_all` field to `true` in the request body.\n2. You can delete a list of select spam reports by specifying the email addresses in the `emails` array of the request body." }, "response": [ { "id": "a7be5c81-01b2-4e92-93ff-46480860210f", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"delete_all\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/suppression/spam_reports", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "spam_reports" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-a7be5c81-01b2-4e92-93ff-46480860210f" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-6e77ccc3-b4e7-4f06-a2f2-0a3a589501dc" } ], "id": "83375de6-1b78-49d7-a548-acf516e44a62", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-83375de6-1b78-49d7-a548-acf516e44a62" }, { "name": "unsubscribes", "item": [ { "name": "Retrieve all global suppressions", "id": "96187e0f-3197-4e08-bc57-065972291566", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/suppression/unsubscribes?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "unsubscribes" ], "query": [ { "description": "Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] }, "description": "**This endpoint allows you to retrieve a paginated list of all email address that are globally suppressed.**\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." }, "response": [ { "id": "9aceb215-a5c2-4605-9e56-100f5e38a0e2", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the `on-behalf-of` header. See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/suppression/unsubscribes?start_time=&end_time=&limit=&offset=0&email=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "suppression", "unsubscribes" ], "query": [ { "description": "Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).", "key": "start_time", "value": "" }, { "description": "Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).", "key": "end_time", "value": "" }, { "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.", "key": "limit", "value": "" }, { "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.", "key": "offset", "value": "0" }, { "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`.", "key": "email", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"created\": \"\",\n \"email\": \"\"\n },\n {\n \"created\": \"\",\n \"email\": \"\"\n }\n]", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-9aceb215-a5c2-4605-9e56-100f5e38a0e2" } ], "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-96187e0f-3197-4e08-bc57-065972291566" } ], "id": "e8170534-3816-4605-80fd-167e6a5c0f60", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-e8170534-3816-4605-80fd-167e6a5c0f60" } ], "id": "f1921fce-9a37-4019-a356-b4f15845b27b", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-f1921fce-9a37-4019-a356-b4f15845b27b" } ], "id": "c16d7d30-9979-4978-aa03-b9b82385c2a0", "createdAt": "2026-06-05T15:17:51.000Z", "updatedAt": "2026-06-05T15:17:51.000Z", "uid": "35240-c16d7d30-9979-4978-aa03-b9b82385c2a0" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sendgrid.com" } ] }