provider Link branding DELETE /whitelabel/links/{id}
@utdk/sendgrid /whitelabel/links/{id}
Delete a branded link
**This endpoint allows you to delete a branded link.** Your request will receive a response with a 204 status code if the deletion was successful. The call does not return the link's details, so if you wish to record these make sure you call the "Retrieve a branded link" endpoint *before* you request its deletion. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.
id path required
The ID of the branded link you want to retrieve.
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
deleteWhitelabelLinksId
DELETE/whitelabel/links/{id}
**This endpoint allows you to delete a branded link.** Your request will receive a response with a 204 status code if the deletion was successful. The call does not return the link's details, so if you wish to record these make sure you call the "Retrieve a branded link" endpoint *before* you request its deletion. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

Parameters

required

The ID of the branded link you want to retrieve.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

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