Retrieve a Global Suppression · Email Activity (beta)

provider Suppressions - Global Suppressions GET /asm/suppressions/global/{email}

@utdk/sendgrid /asm/suppressions/global/{email}

Retrieve a Global Suppression

**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.** If 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.

email path 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.; string
on-behalf-of header: string

Try it

Authentication

Configure credentials for Email Activity (beta)

Gateway

The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Execution Mode

Gateway URL

Saved automatically to browser storage.

Code snippet

Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getAsmSuppressionsGlobalEmail({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})