Skip to content

Latest commit

 

History

History
226 lines (143 loc) · 7.5 KB

SendersApi.md

File metadata and controls

226 lines (143 loc) · 7.5 KB
Raw

\SendersApi

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

Method HTTP request Description
CreateSender Post /senders Create a new sender
DeleteSender Delete /senders/{senderId} Delete a sender
GetIps Get /senders/ips Get all the dedicated IPs for your account
GetIpsFromSender Get /senders/{senderId}/ips Get all the dedicated IPs for a sender
GetSenders Get /senders Get the list of all your senders
UpdateSender Put /senders/{senderId} Update a sender
ValidateSenderByOTP Put /senders/{senderId}/validate Update a sender

CreateSender

CreateSenderModel CreateSender(ctx, optional) Create a new sender

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateSenderOpts struct

Name Type Description Notes
sender optional.Interface of CreateSender sender's name

Return type

CreateSenderModel

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]

DeleteSender

DeleteSender(ctx, senderId) Delete a sender

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
senderId int64 Id of the sender

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]

GetIps

GetIps GetIps(ctx, ) Get all the dedicated IPs for your account

Required Parameters

This endpoint does not need any parameter.

Return type

GetIps

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]

GetIpsFromSender

GetIpsFromSender GetIpsFromSender(ctx, senderId) Get all the dedicated IPs for a sender

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
senderId int64 Id of the sender

Return type

GetIpsFromSender

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]

GetSenders

GetSendersList GetSenders(ctx, optional) Get the list of all your senders

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetSendersOpts struct

Name Type Description Notes
ip optional.String Filter your senders for a specific ip (available for dedicated IP usage only)
domain optional.String Filter your senders for a specific domain

Return type

GetSendersList

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]

UpdateSender

UpdateSender(ctx, senderId, optional) Update a sender

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
senderId int64 Id of the sender
optional *UpdateSenderOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateSenderOpts struct

Name Type Description Notes

sender | optional.Interface of UpdateSender| sender's 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]

ValidateSenderByOTP

ValidateSenderByOTP(ctx, senderId, optional) Update a sender

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
senderId int64 Id of the sender
optional *ValidateSenderByOTPOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ValidateSenderByOTPOpts struct

Name Type Description Notes

otp | optional.Interface of Otp| otp |

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]