openapi

package
v4.0.0-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 24, 2024 License: MIT Imports: 6 Imported by: 0

README

Go API client for

The Twilio SendGrid Link Branding API allows you to configure your domain settings so that all of the click-tracked links, opens, and images in your emails are served from your domain rather than sendgrid.net. Spam filters and recipient servers look at the links within emails to determine whether the email appear trustworthy. They use the reputation of the root domain to determine whether the links can be trusted.

You can also manage Link Branding in the Sender Authentication section of the Twilio SendGrid application user interface.

See [How to Set Up Link Branding](https: //sendgrid.com/docs/ui/account-and-settings/how-to-set-up-link-branding/) for more information.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/sendgrid-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version:
  • Build date: 2024-10-24T13:26:01.766187Z[Etc/UTC]
  • Build package: com.sendgrid.oai.go.SendgridGoGenerator For more information, please visit https://support.sendgrid.com/hc/en-us

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./"

Documentation for API Endpoints

All URIs are relative to https://api.sendgrid.com

Class Method HTTP request Description
AssociateBrandedLinkWithSubuser AssociateBrandedLinkWithSubuser Post /v3/whitelabel/links/{LinkId}/subuser Associate a branded link with a subuser
CreateBrandedLink CreateBrandedLink Post /v3/whitelabel/links Create a branded link
DeleteBrandedLink DeleteBrandedLink Delete /v3/whitelabel/links/{Id} Delete a branded link
DisassociateBrandedLinkFromSubuser DisassociateBrandedLinkFromSubuser Delete /v3/whitelabel/links/subuser Disassociate a branded link from a subuser
GetBrandedLink GetBrandedLink Get /v3/whitelabel/links/{Id} Retrieve a branded link
ListBrandedLink ListBrandedLink Get /v3/whitelabel/links Retrieve all branded links
ListDefaultBrandedLink ListDefaultBrandedLink Get /v3/whitelabel/links/default Retrieve the default branded link
ListSubuserBrandedLink ListSubuserBrandedLink Get /v3/whitelabel/links/subuser Retrieve a subuser's branded link
UpdateBrandedLink UpdateBrandedLink Patch /v3/whitelabel/links/{Id} Update a branded link
ValidateBrandedLink ValidateBrandedLink Post /v3/whitelabel/links/{Id}/validate Validate a branded link

Documentation For Models

Documentation For Authorization

BearerAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService 

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService 

func NewApiService(requestHandler *sendgrid.RequestHandler) *ApiService

func NewApiServiceWithClient 

func NewApiServiceWithClient(client sendgrid.BaseClient) *ApiService

func (*ApiService) AssociateBrandedLinkWithSubuser 

func (c *ApiService) AssociateBrandedLinkWithSubuser(params *AssociateBrandedLinkWithSubuserParam) (interface{}, error)

**This endpoint allows you to associate a branded link with a subuser account.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and validate it. The parent may then associate that branded link with a subuser via the API or the [Subuser Management page of the Twilio SendGrid App](https://app.sendgrid.com/settings/subusers). 

func (c *ApiService) CreateBrandedLink(params *CreateBrandedLinkParam) (interface{}, error)

**This endpoint allows you to create a new branded link.** To create the link branding, supply the root domain and, optionally, the subdomain — these go into separate fields in your request body. The root domain should match your FROM email address. If you provide a subdomain, it must be different from the subdomain you used for authenticating your domain. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. 

func (c *ApiService) DeleteBrandedLink(params *DeleteBrandedLinkParam) (interface{}, error)

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

func (*ApiService) DisassociateBrandedLinkFromSubuser 

func (c *ApiService) DisassociateBrandedLinkFromSubuser(params *DisassociateBrandedLinkFromSubuserParam) (interface{}, error)

**This endpoint allows you to take a branded link away from a subuser.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and validate it. The parent may then associate that branded link with a subuser via the API or the [Subuser Management page of the Twilio SendGrid App](https://app.sendgrid.com/settings/subusers). Your request will receive a response with a 204 status code if the disassociation was successful. 

func (c *ApiService) GetBrandedLink(params *GetBrandedLinkParam) (interface{}, error)

**This endpoint allows you to retrieve a specific branded link by providing its ID.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. 

func (c *ApiService) ListBrandedLink(params *ListBrandedLinkParam) (interface{}, error)

**This endpoint allows you to retrieve all branded links**. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. 

func (c *ApiService) ListDefaultBrandedLink(params *ListDefaultBrandedLinkParam) (interface{}, error)

**This endpoint allows you to retrieve the default branded link.** The default branded link is the actual URL to be used when sending messages. If you have more than one branded link, the default is determined by the following order: * The validated branded link marked as `default` (set when you call the \"Create a branded link\" endpoint or by calling the \"Update a branded link\" endpoint on an existing link) * Legacy branded links (migrated from the whitelabel wizard) * Default SendGrid-branded links (i.e., `100.ct.sendgrid.net`) You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. 

func (c *ApiService) ListSubuserBrandedLink(params *ListSubuserBrandedLinkParam) (interface{}, error)

**This endpoint allows you to retrieve the branded link associated with a subuser.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and then validate it. The parent may then associate that branded link with a subuser via the API or the [Subuser Management page of the Twilio SendGrid App](https://app.sendgrid.com/settings/subusers). 

func (c *ApiService) UpdateBrandedLink(params *UpdateBrandedLinkParam) (interface{}, error)

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

func (c *ApiService) ValidateBrandedLink(params *ValidateBrandedLinkParam) (interface{}, error)

**This endpoint allows you to validate a branded link.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

type AssociateBrandedLinkWithSubuserParam 

type AssociateBrandedLinkWithSubuserParam struct {
	// The ID of the branded link you want to associate.
	LinkId *int32 `json:"link_id"`
	//
	AssociateBrandedLinkWithSubuserRequest *AssociateBrandedLinkWithSubuserRequest `json:"AssociateBrandedLinkWithSubuserRequest,omitempty"`
}

func (*AssociateBrandedLinkWithSubuserParam) SetAssociateBrandedLinkWithSubuserRequest 

func (params *AssociateBrandedLinkWithSubuserParam) SetAssociateBrandedLinkWithSubuserRequest(AssociateBrandedLinkWithSubuserRequest AssociateBrandedLinkWithSubuserRequest) *AssociateBrandedLinkWithSubuserParam

func (*AssociateBrandedLinkWithSubuserParam) SetLinkId 

func (params *AssociateBrandedLinkWithSubuserParam) SetLinkId(LinkId int32) *AssociateBrandedLinkWithSubuserParam

type AssociateBrandedLinkWithSubuserRequest 

type AssociateBrandedLinkWithSubuserRequest struct {
	// The username of the subuser account that you want to associate the branded link with.
	Username *string `json:"username,omitempty"`
}

AssociateBrandedLinkWithSubuserRequest struct for AssociateBrandedLinkWithSubuserRequest

type CreateBrandedLinkParam 

type CreateBrandedLinkParam struct {
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	CreateBrandedLinkRequest *CreateBrandedLinkRequest `json:"CreateBrandedLinkRequest,omitempty"`
}

func (*CreateBrandedLinkParam) SetCreateBrandedLinkRequest 

func (params *CreateBrandedLinkParam) SetCreateBrandedLinkRequest(CreateBrandedLinkRequest CreateBrandedLinkRequest) *CreateBrandedLinkParam

func (*CreateBrandedLinkParam) SetOnbehalfof 

func (params *CreateBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *CreateBrandedLinkParam

type CreateBrandedLinkRequest 

type CreateBrandedLinkRequest struct {
	// The root domain for the subdomain that you are creating the link branding for. This should match your FROM email address.
	Domain string `json:"domain"`
	// The subdomain to create the link branding for. Must be different from the subdomain you used for authenticating your domain.
	Subdomain *string `json:"subdomain,omitempty"`
	// Indicates if you want to use this link branding as the default or fallback. When setting a new default, the existing default link branding will have its default status removed automatically.
	Default *Default `json:"default,omitempty"`
	// The region of the IP address. Can be `eu` or `us`.
	Region *Region `json:"region,omitempty"`
}

CreateBrandedLinkRequest struct for CreateBrandedLinkRequest

type Default 

type Default bool

Default the model 'Default' 

const (
	DEFAULT_TRUE  Default = true
	DEFAULT_FALSE Default = false
)

List of Default

type Default1 

type Default1 bool

Default1 the model 'Default1' 

const (
	DEFAULT1_TRUE  Default1 = true
	DEFAULT1_FALSE Default1 = false
)

List of Default1

type Default2 

type Default2 bool

Default2 the model 'Default2' 

const (
	DEFAULT2_TRUE  Default2 = true
	DEFAULT2_FALSE Default2 = false
)

List of Default2

type DeleteBrandedLinkParam 

type DeleteBrandedLinkParam struct {
	// The ID of the branded link you want to retrieve.
	Id *int32 `json:"id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*DeleteBrandedLinkParam) SetId 

func (params *DeleteBrandedLinkParam) SetId(Id int32) *DeleteBrandedLinkParam

func (*DeleteBrandedLinkParam) SetOnbehalfof 

func (params *DeleteBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *DeleteBrandedLinkParam

type DisassociateBrandedLinkFromSubuserParam 

type DisassociateBrandedLinkFromSubuserParam struct {
	// The username of the subuser account that you want to disassociate a branded link from.
	Username *string `json:"username"`
}

func (*DisassociateBrandedLinkFromSubuserParam) SetUsername 

func (params *DisassociateBrandedLinkFromSubuserParam) SetUsername(Username string) *DisassociateBrandedLinkFromSubuserParam

type GetBrandedLinkParam 

type GetBrandedLinkParam struct {
	// The ID of the branded link you want to retrieve.
	Id *int32 `json:"id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*GetBrandedLinkParam) SetId 

func (params *GetBrandedLinkParam) SetId(Id int32) *GetBrandedLinkParam

func (*GetBrandedLinkParam) SetOnbehalfof 

func (params *GetBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *GetBrandedLinkParam

type Legacy 

type Legacy bool

Legacy the model 'Legacy' 

const (
	LEGACY_TRUE  Legacy = true
	LEGACY_FALSE Legacy = false
)

List of Legacy

type LinkBranding200 

type LinkBranding200 struct {
	// The ID of the branded link.
	Id int32 `json:"id"`
	// The root domain of the branded link.
	Domain string `json:"domain"`
	// The subdomain used to generate the DNS records for this link branding. This subdomain must be different from the subdomain used for your authenticated domain.
	Subdomain *string `json:"subdomain,omitempty"`
	// The username of the account that this link branding is associated with.
	Username string `json:"username"`
	// The ID of the user that this link branding is associated with.
	UserId int32 `json:"user_id"`
	// Indicates if this is the default link branding.
	Default Default2 `json:"default"`
	// Indicates if this link branding is valid.
	Valid Valid3 `json:"valid"`
	// Indicates if this link branding was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create new link branding if you need to update it.
	Legacy Legacy             `json:"legacy"`
	Dns    LinkBranding200Dns `json:"dns"`
}

LinkBranding200 struct for LinkBranding200

type LinkBranding200Dns 

type LinkBranding200Dns struct {
	DomainCname LinkBranding200DnsDomainCname `json:"domain_cname"`
	OwnerCname  *LinkBranding200DnsOwnerCname `json:"owner_cname,omitempty"`
}

LinkBranding200Dns The DNS records generated for this link branding.

type LinkBranding200DnsDomainCname 

type LinkBranding200DnsDomainCname struct {
	// Indicates if the DNS record is valid.
	Valid Valid4 `json:"valid"`
	// The type of DNS record that was generated.
	Type Type `json:"type"`
	// The domain that this link branding will use for the links in your email.
	Host string `json:"host"`
	// The domain that the DNS record points to.
	Data string `json:"data"`
}

LinkBranding200DnsDomainCname The DNS record generated to point to your link branding subdomain.

type LinkBranding200DnsOwnerCname 

type LinkBranding200DnsOwnerCname struct {
	// Indicates if the DNS record is valid.
	Valid Valid5 `json:"valid"`
	// The type of DNS record generated.
	Type *Type1 `json:"type,omitempty"`
	// Used to verify the link branding. The subdomain of this domain is the ID of the user who created the link branding.
	Host string `json:"host"`
	// The domain that the DNS record points to.
	Data string `json:"data"`
}

LinkBranding200DnsOwnerCname The DNS record generated to verify who created the link branding.

type ListBrandedLinkParam 

type ListBrandedLinkParam struct {
	// Limits the number of results returned per page.
	Limit *int32 `json:"limit,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListBrandedLinkParam) SetLimit 

func (params *ListBrandedLinkParam) SetLimit(Limit int32) *ListBrandedLinkParam

func (*ListBrandedLinkParam) SetOnbehalfof 

func (params *ListBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *ListBrandedLinkParam

type ListDefaultBrandedLinkParam 

type ListDefaultBrandedLinkParam struct {
	// The domain to match against when finding the default branded link.
	Domain *string `json:"domain,omitempty"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ListDefaultBrandedLinkParam) SetDomain 

func (params *ListDefaultBrandedLinkParam) SetDomain(Domain string) *ListDefaultBrandedLinkParam

func (*ListDefaultBrandedLinkParam) SetOnbehalfof 

func (params *ListDefaultBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *ListDefaultBrandedLinkParam

type ListSubuserBrandedLinkParam 

type ListSubuserBrandedLinkParam struct {
	// The username of the subuser to retrieve associated branded links for.
	Username *string `json:"username"`
}

func (*ListSubuserBrandedLinkParam) SetUsername 

func (params *ListSubuserBrandedLinkParam) SetUsername(Username string) *ListSubuserBrandedLinkParam

type Region 

type Region string

Region the model 'Region' 

const (
	REGION_EU Region = "eu"
	REGION_US Region = "us"
)

List of Region

type Type 

type Type string

Type the model 'Type' 

const (
	TYPE_CNAME Type = "cname"
	TYPE_TXT   Type = "txt"
	TYPE_MX    Type = "mx"
)

List of Type

type Type1 

type Type1 string

Type1 the model 'Type1' 

const (
	TYPE1_CNAME Type1 = "cname"
	TYPE1_TXT   Type1 = "txt"
	TYPE1_MX    Type1 = "mx"
)

List of Type1

type UpdateBrandedLinkParam 

type UpdateBrandedLinkParam struct {
	// The ID of the branded link you want to retrieve.
	Id *int32 `json:"id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
	//
	UpdateBrandedLinkRequest *UpdateBrandedLinkRequest `json:"UpdateBrandedLinkRequest,omitempty"`
}

func (*UpdateBrandedLinkParam) SetId 

func (params *UpdateBrandedLinkParam) SetId(Id int32) *UpdateBrandedLinkParam

func (*UpdateBrandedLinkParam) SetOnbehalfof 

func (params *UpdateBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *UpdateBrandedLinkParam

func (*UpdateBrandedLinkParam) SetUpdateBrandedLinkRequest 

func (params *UpdateBrandedLinkParam) SetUpdateBrandedLinkRequest(UpdateBrandedLinkRequest UpdateBrandedLinkRequest) *UpdateBrandedLinkParam

type UpdateBrandedLinkRequest 

type UpdateBrandedLinkRequest struct {
	// 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.
	Default *Default1 `json:"default,omitempty"`
}

UpdateBrandedLinkRequest struct for UpdateBrandedLinkRequest

type Valid 

type Valid bool

Valid the model 'Valid' 

const (
	VALID_TRUE  Valid = true
	VALID_FALSE Valid = false
)

List of Valid

type Valid1 

type Valid1 bool

Valid1 the model 'Valid1' 

const (
	VALID1_TRUE  Valid1 = true
	VALID1_FALSE Valid1 = false
)

List of Valid1

type Valid2 

type Valid2 bool

Valid2 the model 'Valid2' 

const (
	VALID2_TRUE  Valid2 = true
	VALID2_FALSE Valid2 = false
)

List of Valid2

type Valid3 

type Valid3 bool

Valid3 the model 'Valid3' 

const (
	VALID3_TRUE  Valid3 = true
	VALID3_FALSE Valid3 = false
)

List of Valid3

type Valid4 

type Valid4 bool

Valid4 the model 'Valid4' 

const (
	VALID4_TRUE  Valid4 = true
	VALID4_FALSE Valid4 = false
)

List of Valid4

type Valid5 

type Valid5 bool

Valid5 the model 'Valid5' 

const (
	VALID5_TRUE  Valid5 = true
	VALID5_FALSE Valid5 = false
)

List of Valid5

type ValidateBrandedLink200Response 

type ValidateBrandedLink200Response struct {
	// The ID of the branded link.
	Id int32 `json:"id"`
	// Indicates if the link branding is valid.
	Valid             Valid                                           `json:"valid"`
	ValidationResults ValidateBrandedLink200ResponseValidationResults `json:"validation_results"`
}

ValidateBrandedLink200Response struct for ValidateBrandedLink200Response

type ValidateBrandedLink200ResponseValidationResults 

type ValidateBrandedLink200ResponseValidationResults struct {
	DomainCname ValidateBrandedLink200ResponseValidationResultsDomainCname `json:"domain_cname"`
	OwnerCname  *ValidateBrandedLink200ResponseValidationResultsOwnerCname `json:"owner_cname,omitempty"`
}

ValidateBrandedLink200ResponseValidationResults The individual validation results for each of the DNS records associated with this branded link.

type ValidateBrandedLink200ResponseValidationResultsDomainCname 

type ValidateBrandedLink200ResponseValidationResultsDomainCname struct {
	// Indicates if this DNS record is valid.
	Valid Valid1 `json:"valid"`
	// Null if the DNS record is valid. If the DNS record is invalid, this will explain why.
	Reason string `json:"reason"`
}

ValidateBrandedLink200ResponseValidationResultsDomainCname The DNS record generated for the sending domain used for this branded link.

type ValidateBrandedLink200ResponseValidationResultsOwnerCname 

type ValidateBrandedLink200ResponseValidationResultsOwnerCname struct {
	// Indicates if the DNS record is valid.
	Valid Valid2 `json:"valid"`
	// Null if valid. If the DNS record is invalid, this will explain why.
	Reason string `json:"reason"`
}

ValidateBrandedLink200ResponseValidationResultsOwnerCname The DNS record created to verify the branded link.

type ValidateBrandedLink500Response 

type ValidateBrandedLink500Response struct {
	// The reasons why the validation failed.
	Errors []ValidateBrandedLink500ResponseErrorsInner `json:"errors"`
}

ValidateBrandedLink500Response struct for ValidateBrandedLink500Response

type ValidateBrandedLink500ResponseErrorsInner 

type ValidateBrandedLink500ResponseErrorsInner struct {
	// The reason why the link whitelabel could not be validated.
	Message string `json:"message"`
}

ValidateBrandedLink500ResponseErrorsInner struct for ValidateBrandedLink500ResponseErrorsInner

type ValidateBrandedLinkParam 

type ValidateBrandedLinkParam struct {
	// The ID of the branded link that you want to validate.
	Id *int32 `json:"id"`
	// The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.
	Onbehalfof *string `json:"on-behalf-of,omitempty"`
}

func (*ValidateBrandedLinkParam) SetId 

func (params *ValidateBrandedLinkParam) SetId(Id int32) *ValidateBrandedLinkParam

func (*ValidateBrandedLinkParam) SetOnbehalfof 

func (params *ValidateBrandedLinkParam) SetOnbehalfof(Onbehalfof string) *ValidateBrandedLinkParam

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.