Skip to content

Latest commit

 

History

History
146 lines (91 loc) · 4.8 KB

DomainsApi.md

File metadata and controls

146 lines (91 loc) · 4.8 KB

\DomainsApi

All URIs are relative to https://api.brevo.com/v3

Method HTTP request Description
AuthenticateDomain Put /senders/domains/{domainName}/authenticate Authenticate a domain
CreateDomain Post /senders/domains Create a new domain
DeleteDomain Delete /senders/domains/{domainName} Delete a domain
GetDomainConfiguration Get /senders/domains/{domainName} Validate domain configuration
GetDomains Get /senders/domains Get the list of all your domains

AuthenticateDomain

AuthenticateDomainModel AuthenticateDomain(ctx, domainName) Authenticate a domain

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainName string Domain name

Return type

AuthenticateDomainModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateDomain

CreateDomainModel CreateDomain(ctx, optional) Create a new domain

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CreateDomainOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateDomainOpts struct

Name Type Description Notes
domainName optional.Interface of CreateDomain domain's name

Return type

CreateDomainModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteDomain

DeleteDomain(ctx, domainName) Delete a domain

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainName string Domain name

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDomainConfiguration

GetDomainConfigurationModel GetDomainConfiguration(ctx, domainName) Validate domain configuration

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainName string Domain name

Return type

GetDomainConfigurationModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDomains

GetDomainsList GetDomains(ctx, ) Get the list of all your domains

Required Parameters

This endpoint does not need any parameter.

Return type

GetDomainsList

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]