provider Domain Authentication PATCH /whitelabel/domains/{domain_id}
@utdk/sendgrid /whitelabel/domains/{domain_id}
Update an authenticated domain
**This endpoint allows you to update the settings for an authenticated domain.**
domain_id path required
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.

Saved automatically to browser storage.

patchWhitelabelDomainsDomainId
PATCH/whitelabel/domains/{domain_id}
**This endpoint allows you to update the settings for an authenticated domain.**

Parameters

required

Input

Indicates whether to generate a custom SPF record for manual security.

Indicates whether this is the default authenticated domain.

Enter a gateway URL above to enable sending.

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

TypeScript

import sendgrid from '@utdk/sendgrid';

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