provider Domain Authentication POST /whitelabel/domains
@utdk/sendgrid /whitelabel/domains
Authenticate a domain
**This endpoint allows you to authenticate a domain.** If you are authenticating a domain for a subuser, you have two options: 1. Use the "username" parameter. This allows you to authenticate a domain on behalf of your subuser. This means the subuser is able to see and modify the authenticated domain. 2. Use the Association workflow (see Associate Domain section). This allows you to authenticate a domain created by the parent to a subuser. This means the subuser will default to the assigned domain, but will not be able to see or modify that authenticated domain. However, if the subuser authenticates their own domain it will overwrite the assigned domain.
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.

postWhitelabelDomains
POST/whitelabel/domains
**This endpoint allows you to authenticate a domain.** If you are authenticating a domain for a subuser, you have two options: 1. Use the "username" parameter. This allows you to authenticate a domain on behalf of your subuser. This means the subuser is able to see and modify the authenticated domain. 2. Use the Association workflow (see Associate Domain section). This allows you to authenticate a domain created by the parent to a subuser. This means the subuser will default to the assigned domain, but will not be able to see or modify that authenticated domain. However, if the subuser authenticates their own domain it will overwrite the assigned domain.

Input

Whether to allow SendGrid to manage your SPF records, DKIM keys, and DKIM key rotation.

Add a custom DKIM selector. Accepts three letters or numbers.

Specify whether to use a custom SPF or allow SendGrid to manage your SPF. This option is only available to authenticated domains set up for manual security.

Whether to use this authenticated domain as the fallback if no authenticated domains match the sender's domain.

required

Domain being authenticated.

The IP addresses that will be included in the custom SPF record for this authenticated domain.

The subdomain to use for this authenticated domain.

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