provider Link branding PATCH /whitelabel/links/{id}
@utdk/sendgrid /whitelabel/links/{id}
Update a branded link
**This endpoint allows you to update a specific branded link. You can use this endpoint to change a branded link's default status.** 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)
patchWhitelabelLinksId
PATCH/whitelabel/links/{id}
**This endpoint allows you to update a specific branded link. You can use this endpoint to change a branded link's default status.** 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.

Input

Indicates if the branded link is set as the default. When setting a new default, the existing default link branding will have its default status removed automatically.

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.patchWhitelabelLinksId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})