Lib.rs

› Web programming › HTTP client
#email #send-email #contact #error #sms #account #send-message

brevo

Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo

Owned by ClaXXX.

1 stable release

new 1.0.0 Mar 3, 2025

#78 in HTTP client

MIT license

2MB
31K SLoC

Rust API client for openapi

Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :

  • Manage your campaigns and get the statistics
  • Manage your contacts
  • Send transactional Emails and SMS
  • and much more...

You can download our wrappers at https://github.com/orgs/brevo

Possible responses

Code Message
200 OK. Successful Request
201 OK. Successful Creation
202 OK. Request accepted
204 OK. Successful Update/Deletion
400 Error. Bad Request
401 Error. Authentication Needed
402 Error. Not enough credit, plan upgrade needed
403 Error. Permission denied
404 Error. Object does not exist
405 Error. Method not allowed
406 Error. Not Acceptable
422 Error. Unprocessable Entity

For more information, please visit https://account.brevo.com/support

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 3.0.0
  • Package version: 3.0.0
  • Generator version: 7.13.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi get_account GET /account Get your account information, plan and credits details
AccountApi get_account_activity GET /organization/activities Get user activity logs
BalanceApi begin_transaction POST /loyalty/balance/programs/{pid}/transactions Create new transaction
BalanceApi cancel_transaction POST /loyalty/balance/programs/{pid}/transactions/{tid}/cancel Cancel transaction
BalanceApi complete_transaction POST /loyalty/balance/programs/{pid}/transactions/{tid}/complete Complete transaction
BalanceApi create_balance_limit POST /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits Create balance limits
BalanceApi create_balance_order POST /loyalty/balance/programs/{pid}/create-order Create balance order
BalanceApi delete_balance_definition DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Delete balance definition
BalanceApi delete_balance_limit DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Delete balance limit
BalanceApi get_balance_definition GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Get balance definition
BalanceApi get_balance_definition_list GET /loyalty/balance/programs/{pid}/balance-definitions Get balance definition list
BalanceApi get_balance_limit GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Get balance limits
BalanceApi get_contact_balances GET /loyalty/balance/programs/{pid}/contact-balances Get balance list
BalanceApi get_subscription_balances GET /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances Get subscription balances
BalanceApi loyalty_balance_programs_pid_active_balance_get GET /loyalty/balance/programs/{pid}/active-balance Get Active Balances API
BalanceApi loyalty_balance_programs_pid_balance_definitions_post POST /loyalty/balance/programs/{pid}/balance-definitions Create balance definition
BalanceApi loyalty_balance_programs_pid_subscriptions_cid_balances_post POST /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances Create subscription balances
BalanceApi loyalty_balance_programs_pid_transaction_history_get GET /loyalty/balance/programs/{pid}/transaction-history Get Transaction History API
BalanceApi update_balance_definition PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Update balance definition
BalanceApi update_balance_limit PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Updates balance limit
CompaniesApi companies_get GET /companies Get all Companies
CompaniesApi companies_id_delete DELETE /companies/{id} Delete a company
CompaniesApi companies_id_get GET /companies/{id} Get a company
CompaniesApi companies_id_patch PATCH /companies/{id} Update a company
CompaniesApi companies_import_post POST /companies/import Import companies(creation and updation)
CompaniesApi companies_link_unlink_id_patch PATCH /companies/link-unlink/{id} Link and Unlink company with contact and deal
CompaniesApi companies_post POST /companies Create a company
CompaniesApi crm_attributes_companies_get GET /crm/attributes/companies Get company attributes
CompaniesApi crm_attributes_post POST /crm/attributes Create a company/deal attribute
ContactsApi add_contact_to_list POST /contacts/lists/{listId}/contacts/add Add existing contacts to a list
ContactsApi create_attribute POST /contacts/attributes/{attributeCategory}/{attributeName} Create contact attribute
ContactsApi create_contact POST /contacts Create a contact
ContactsApi create_doi_contact POST /contacts/doubleOptinConfirmation Create Contact via DOI (Double-Opt-In) Flow
ContactsApi create_folder POST /contacts/folders Create a folder
ContactsApi create_list POST /contacts/lists Create a list
ContactsApi delete_attribute DELETE /contacts/attributes/{attributeCategory}/{attributeName} Delete an attribute
ContactsApi delete_contact DELETE /contacts/{identifier} Delete a contact
ContactsApi delete_folder DELETE /contacts/folders/{folderId} Delete a folder (and all its lists)
ContactsApi delete_list DELETE /contacts/lists/{listId} Delete a list
ContactsApi delete_multi_attribute_options DELETE /contacts/attributes/{attributeType}/{multipleChoiceAttribute}/{multipleChoiceAttributeOption} Delete a multiple-choice attribute option
ContactsApi get_attributes GET /contacts/attributes List all attributes
ContactsApi get_contact_info GET /contacts/{identifier} Get a contact's details
ContactsApi get_contact_stats GET /contacts/{identifier}/campaignStats Get email campaigns' statistics for a contact
ContactsApi get_contacts GET /contacts Get all the contacts
ContactsApi get_contacts_from_list GET /contacts/lists/{listId}/contacts Get contacts in a list
ContactsApi get_folder GET /contacts/folders/{folderId} Returns a folder's details
ContactsApi get_folder_lists GET /contacts/folders/{folderId}/lists Get lists in a folder
ContactsApi get_folders GET /contacts/folders Get all folders
ContactsApi get_list GET /contacts/lists/{listId} Get a list's details
ContactsApi get_lists GET /contacts/lists Get all the lists
ContactsApi get_segments GET /contacts/segments Get all the segments
ContactsApi import_contacts POST /contacts/import Import contacts
ContactsApi remove_contact_from_list POST /contacts/lists/{listId}/contacts/remove Delete a contact from a list
ContactsApi request_contact_export POST /contacts/export Export contacts
ContactsApi update_attribute PUT /contacts/attributes/{attributeCategory}/{attributeName} Update contact attribute
ContactsApi update_batch_contacts POST /contacts/batch Update multiple contacts
ContactsApi update_contact PUT /contacts/{identifier} Update a contact
ContactsApi update_folder PUT /contacts/folders/{folderId} Update a folder
ContactsApi update_list PUT /contacts/lists/{listId} Update a list
ConversationsApi conversations_agent_online_ping_post POST /conversations/agentOnlinePing Sets agent’s status to online for 2-3 minutes
ConversationsApi conversations_messages_id_delete DELETE /conversations/messages/{id} Delete a message sent by an agent
ConversationsApi conversations_messages_id_get GET /conversations/messages/{id} Get a message
ConversationsApi conversations_messages_id_put PUT /conversations/messages/{id} Update a message sent by an agent
ConversationsApi conversations_messages_post POST /conversations/messages Send a message as an agent
ConversationsApi conversations_pushed_messages_id_delete DELETE /conversations/pushedMessages/{id} Delete an automated message
ConversationsApi conversations_pushed_messages_id_get GET /conversations/pushedMessages/{id} Get an automated message
ConversationsApi conversations_pushed_messages_id_put PUT /conversations/pushedMessages/{id} Update an automated message
ConversationsApi conversations_pushed_messages_post POST /conversations/pushedMessages Send an automated message to a visitor
CouponsApi create_coupon_collection POST /couponCollections Create а coupon collection
CouponsApi create_coupons POST /coupons Create coupons for a coupon collection
CouponsApi get_coupon_collection GET /couponCollections/{id} Get a coupon collection by id
CouponsApi get_coupon_collections GET /couponCollections Get all your coupon collections
CouponsApi update_coupon_collection PATCH /couponCollections/{id} Update a coupon collection by id
DealsApi crm_attributes_deals_get GET /crm/attributes/deals Get deal attributes
DealsApi crm_attributes_post POST /crm/attributes Create a company/deal attribute
DealsApi crm_deals_get GET /crm/deals Get all deals
DealsApi crm_deals_id_delete DELETE /crm/deals/{id} Delete a deal
DealsApi crm_deals_id_get GET /crm/deals/{id} Get a deal
DealsApi crm_deals_id_patch PATCH /crm/deals/{id} Update a deal
DealsApi crm_deals_import_post POST /crm/deals/import Import deals(creation and updation)
DealsApi crm_deals_link_unlink_id_patch PATCH /crm/deals/link-unlink/{id} Link and Unlink a deal with contacts and companies
DealsApi crm_deals_post POST /crm/deals Create a deal
DealsApi crm_pipeline_details_all_get GET /crm/pipeline/details/all Get all pipelines
DealsApi crm_pipeline_details_get GET /crm/pipeline/details Get pipeline stages
DealsApi crm_pipeline_details_pipeline_id_get GET /crm/pipeline/details/{pipelineID} Get a pipeline
DomainsApi authenticate_domain PUT /senders/domains/{domainName}/authenticate Authenticate a domain
DomainsApi create_domain POST /senders/domains Create a new domain
DomainsApi delete_domain DELETE /senders/domains/{domainName} Delete a domain
DomainsApi get_domain_configuration GET /senders/domains/{domainName} Validate domain configuration
DomainsApi get_domains GET /senders/domains Get the list of all your domains
EcommerceApi create_batch_order POST /orders/status/batch Create orders in batch
EcommerceApi create_order POST /orders/status Managing the status of the order
EcommerceApi create_update_batch_category POST /categories/batch Create categories in batch
EcommerceApi create_update_batch_products POST /products/batch Create products in batch
EcommerceApi create_update_category POST /categories Create/Update a category
EcommerceApi create_update_product POST /products Create/Update a product
EcommerceApi ecommerce_activate_post POST /ecommerce/activate Activate the eCommerce app
EcommerceApi ecommerce_attribution_metrics_conversion_source_conversion_source_id_get GET /ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId} Get detailed attribution metrics for a single Brevo campaign or workflow
EcommerceApi ecommerce_attribution_metrics_get GET /ecommerce/attribution/metrics Get attribution metrics for one or more Brevo campaigns or workflows
EcommerceApi ecommerce_attribution_products_conversion_source_conversion_source_id_get GET /ecommerce/attribution/products/{conversionSource}/{conversionSourceId} Get attributed product sales for a single Brevo campaign or workflow
EcommerceApi ecommerce_config_display_currency_get GET /ecommerce/config/displayCurrency Get the ISO 4217 compliant display currency code for your Brevo account
EcommerceApi get_categories GET /categories Return all your categories
EcommerceApi get_category_info GET /categories/{id} Get a category details
EcommerceApi get_orders GET /orders Get order details
EcommerceApi get_product_info GET /products/{id} Get a product's details
EcommerceApi get_products GET /products Return all your products
EcommerceApi set_config_display_currency POST /ecommerce/config/displayCurrency Set the ISO 4217 compliant display currency code for your Brevo account
EmailCampaignsApi create_email_campaign POST /emailCampaigns Create an email campaign
EmailCampaignsApi delete_email_campaign DELETE /emailCampaigns/{campaignId} Delete an email campaign
EmailCampaignsApi email_export_recipients POST /emailCampaigns/{campaignId}/exportRecipients Export the recipients of an email campaign
EmailCampaignsApi get_ab_test_campaign_result GET /emailCampaigns/{campaignId}/abTestCampaignResult Get an A/B test email campaign results
EmailCampaignsApi get_email_campaign GET /emailCampaigns/{campaignId} Get an email campaign report
EmailCampaignsApi get_email_campaigns GET /emailCampaigns Return all your created email campaigns
EmailCampaignsApi get_shared_template_url GET /emailCampaigns/{campaignId}/sharedUrl Get a shared template url
EmailCampaignsApi send_email_campaign_now POST /emailCampaigns/{campaignId}/sendNow Send an email campaign immediately, based on campaignId
EmailCampaignsApi send_report POST /emailCampaigns/{campaignId}/sendReport Send the report of a campaign
EmailCampaignsApi send_test_email POST /emailCampaigns/{campaignId}/sendTest Send an email campaign to your test list
EmailCampaignsApi update_campaign_status PUT /emailCampaigns/{campaignId}/status Update an email campaign status
EmailCampaignsApi update_email_campaign PUT /emailCampaigns/{campaignId} Update an email campaign
EmailCampaignsApi upload_image_to_gallery POST /emailCampaigns/images Upload an image to your account's image gallery
EventApi create_event POST /events Create an event
ExternalFeedsApi create_external_feed POST /feeds Create an external feed
ExternalFeedsApi delete_external_feed DELETE /feeds/{uuid} Delete an external feed
ExternalFeedsApi get_all_external_feeds GET /feeds Fetch all external feeds
ExternalFeedsApi get_external_feed_by_uuid GET /feeds/{uuid} Get an external feed by UUID
ExternalFeedsApi update_external_feed PUT /feeds/{uuid} Update an external feed
FilesApi crm_files_get GET /crm/files Get all files
FilesApi crm_files_id_data_get GET /crm/files/{id}/data Get file details
FilesApi crm_files_id_delete DELETE /crm/files/{id} Delete a file
FilesApi crm_files_id_get GET /crm/files/{id} Download a file
FilesApi crm_files_post POST /crm/files Upload a file
InboundParsingApi get_inbound_email_attachment GET /inbound/attachments/{downloadToken} Retrieve inbound attachment with download token.
InboundParsingApi get_inbound_email_events GET /inbound/events Get the list of all the events for the received emails.
InboundParsingApi get_inbound_email_events_by_uuid GET /inbound/events/{uuid} Fetch all events history for one particular received email.
MasterAccountApi corporate_group_id_delete DELETE /corporate/group/{id} Delete a group
MasterAccountApi corporate_group_id_get GET /corporate/group/{id} GET a group details
MasterAccountApi corporate_group_id_put PUT /corporate/group/{id} Update a group of sub-accounts
MasterAccountApi corporate_group_post POST /corporate/group Create a group of sub-accounts
MasterAccountApi corporate_group_unlink_group_id_sub_accounts_put PUT /corporate/group/unlink/{groupId}/subAccounts Delete sub-account from group
MasterAccountApi corporate_ip_get GET /corporate/ip List of all IPs
MasterAccountApi corporate_master_account_get GET /corporate/masterAccount Get the details of requested master account
MasterAccountApi corporate_sso_token_post POST /corporate/ssoToken Generate SSO token to access admin account
MasterAccountApi corporate_sub_account_get GET /corporate/subAccount Get the list of all the sub-accounts of the master account.
MasterAccountApi corporate_sub_account_id_applications_toggle_put PUT /corporate/subAccount/{id}/applications/toggle Enable/disable sub-account application(s)
MasterAccountApi corporate_sub_account_id_delete DELETE /corporate/subAccount/{id} Delete a sub-account
MasterAccountApi corporate_sub_account_id_get GET /corporate/subAccount/{id} Get sub-account details
MasterAccountApi corporate_sub_account_id_plan_put PUT /corporate/subAccount/{id}/plan Update sub-account plan
MasterAccountApi corporate_sub_account_ip_associate_post POST /corporate/subAccount/ip/associate Associate an IP to sub-accounts
MasterAccountApi corporate_sub_account_ip_dissociate_put PUT /corporate/subAccount/ip/dissociate Dissociate an IP to sub-accounts
MasterAccountApi corporate_sub_account_key_post POST /corporate/subAccount/key Create an API key for a sub-account
MasterAccountApi corporate_sub_account_post POST /corporate/subAccount Create a new sub-account under a master account.
MasterAccountApi corporate_sub_account_sso_token_post POST /corporate/subAccount/ssoToken Generate SSO token to access sub-account
MasterAccountApi corporate_sub_accounts_plan_put PUT /corporate/subAccounts/plan Update sub-accounts plan
MasterAccountApi corporate_user_email_permissions_put PUT /corporate/user/{email}/permissions Change admin user permissions
MasterAccountApi corporate_user_invitation_action_email_put PUT /corporate/user/invitation/{action}/{email} Resend / cancel admin user invitation
MasterAccountApi corporate_user_revoke_email_delete DELETE /corporate/user/revoke/{email} Revoke an admin user
MasterAccountApi get_account_activity GET /organization/activities Get user activity logs
MasterAccountApi get_corporate_invited_users_list GET /corporate/invited/users Get the list of all admin users
MasterAccountApi get_corporate_user_permission GET /corporate/user/{email}/permissions Check admin user permissions
MasterAccountApi get_sub_account_groups GET /corporate/groups Get the list of groups
MasterAccountApi invite_admin_user POST /corporate/user/invitation/send Send invitation to an admin user
NotesApi crm_notes_get GET /crm/notes Get all notes
NotesApi crm_notes_id_delete DELETE /crm/notes/{id} Delete a note
NotesApi crm_notes_id_get GET /crm/notes/{id} Get a note
NotesApi crm_notes_id_patch PATCH /crm/notes/{id} Update a note
NotesApi crm_notes_post POST /crm/notes Create a note
PaymentsApi create_payment_request POST /payments/requests Create a payment request
PaymentsApi delete_payment_request DELETE /payments/requests/{id} Delete a payment request.
PaymentsApi get_payment_request GET /payments/requests/{id} Get payment request details
ProcessApi get_process GET /processes/{processId} Return the informations for a process
ProcessApi get_processes GET /processes Return all the processes for your account
ProgramApi create_new_lp POST /loyalty/config/programs Create loyalty program
ProgramApi delete_contact_members DELETE /loyalty/config/programs/{pid}/subscription-members Delete subscription member
ProgramApi delete_loyalty_program DELETE /loyalty/config/programs/{pid} Delete Loyalty Program
ProgramApi get_loyalty_program_info GET /loyalty/config/programs/{pid} Get loyalty program Info
ProgramApi get_lp_list GET /loyalty/config/programs Get loyalty program list
ProgramApi get_parameter_subscription_info GET /loyalty/config/programs/{pid}/account-info Get Subscription Data
ProgramApi partially_update_loyalty_program PATCH /loyalty/config/programs/{pid} Partially update loyalty program
ProgramApi publish_loyalty_program POST /loyalty/config/programs/{pid}/publish Publish loyalty program
ProgramApi subscribe_member_to_a_subscription POST /loyalty/config/programs/{pid}/subscription-members Create subscription member
ProgramApi subscribe_to_loyalty_program POST /loyalty/config/programs/{pid}/subscriptions Create subscription
ProgramApi update_loyalty_program PUT /loyalty/config/programs/{pid} Update loyalty program
RewardApi complete_redeem_transaction POST /loyalty/offer/programs/{pid}/rewards/redeem/{tid}/complete Complete redeem voucher request
RewardApi create_reward POST /loyalty/offer/programs/{pid}/offers Create a reward
RewardApi create_voucher POST /loyalty/offer/programs/{pid}/rewards/attribute Create a voucher
RewardApi get_code_count GET /loyalty/offer/programs/{pid}/code-pools/{cpid}/codes-count Get code count
RewardApi loyalty_offer_programs_pid_offers_get GET /loyalty/offer/programs/{pid}/offers Get Reward Page API
RewardApi loyalty_offer_programs_pid_rewards_rid_get GET /loyalty/offer/programs/{pid}/rewards/{rid} Get reward information
RewardApi loyalty_offer_programs_pid_vouchers_get GET /loyalty/offer/programs/{pid}/vouchers Get voucher for a contact
RewardApi redeem_voucher POST /loyalty/offer/programs/{pid}/rewards/redeem Create redeem voucher request
RewardApi revoke_vouchers DELETE /loyalty/offer/programs/{pid}/rewards/revoke Revoke vouchers
RewardApi validate_reward POST /loyalty/offer/programs/{pid}/rewards/validate Validate a reward
SmsCampaignsApi create_sms_campaign POST /smsCampaigns Creates an SMS campaign
SmsCampaignsApi delete_sms_campaign DELETE /smsCampaigns/{campaignId} Delete an SMS campaign
SmsCampaignsApi get_sms_campaign GET /smsCampaigns/{campaignId} Get an SMS campaign
SmsCampaignsApi get_sms_campaigns GET /smsCampaigns Returns the information for all your created SMS campaigns
SmsCampaignsApi request_sms_recipient_export POST /smsCampaigns/{campaignId}/exportRecipients Export an SMS campaign's recipients
SmsCampaignsApi send_sms_campaign_now POST /smsCampaigns/{campaignId}/sendNow Send your SMS campaign immediately
SmsCampaignsApi send_sms_report POST /smsCampaigns/{campaignId}/sendReport Send an SMS campaign's report
SmsCampaignsApi send_test_sms POST /smsCampaigns/{campaignId}/sendTest Send a test SMS campaign
SmsCampaignsApi update_sms_campaign PUT /smsCampaigns/{campaignId} Update an SMS campaign
SmsCampaignsApi update_sms_campaign_status PUT /smsCampaigns/{campaignId}/status Update a campaign's status
SendersApi create_sender POST /senders Create a new sender
SendersApi delete_sender DELETE /senders/{senderId} Delete a sender
SendersApi get_ips GET /senders/ips Get all the dedicated IPs for your account
SendersApi get_ips_from_sender GET /senders/{senderId}/ips Get all the dedicated IPs for a sender
SendersApi get_senders GET /senders Get the list of all your senders
SendersApi update_sender PUT /senders/{senderId} Update a sender
SendersApi validate_sender_by_otp PUT /senders/{senderId}/validate Validate Sender using OTP
TasksApi crm_tasks_get GET /crm/tasks Get all tasks
TasksApi crm_tasks_id_delete DELETE /crm/tasks/{id} Delete a task
TasksApi crm_tasks_id_get GET /crm/tasks/{id} Get a task
TasksApi crm_tasks_id_patch PATCH /crm/tasks/{id} Update a task
TasksApi crm_tasks_post POST /crm/tasks Create a task
TasksApi crm_tasktypes_get GET /crm/tasktypes Get all task types
TierApi add_subscription_to_tier POST /loyalty/tier/programs/{pid}/contacts/{cid}/tiers/{tid} Assign a tier
TierApi create_tier_for_tier_group POST /loyalty/tier/programs/{pid}/tier-groups/{gid}/tiers Create a tier
TierApi create_tier_group POST /loyalty/tier/programs/{pid}/tier-groups Create a tier group
TierApi delete_tier DELETE /loyalty/tier/programs/{pid}/tiers/{tid} Delete tier
TierApi delete_tier_group DELETE /loyalty/tier/programs/{pid}/tier-groups/{gid} Delete tier group
TierApi get_list_of_tier_groups GET /loyalty/tier/programs/{pid}/tier-groups List tier groups
TierApi get_loyalty_program_tier GET /loyalty/tier/programs/{pid}/tiers List tiers
TierApi get_tier_group GET /loyalty/tier/programs/{pid}/tier-groups/{gid} Get tier group
TierApi update_tier PUT /loyalty/tier/programs/{pid}/tiers/{tid} Update tier
TierApi update_tier_group PUT /loyalty/tier/programs/{pid}/tier-groups/{gid} Update tier group
TransactionalEmailsApi block_new_domain POST /smtp/blockedDomains Add a new domain to the list of blocked domains
TransactionalEmailsApi create_smtp_template POST /smtp/templates Create an email template
TransactionalEmailsApi delete_blocked_domain DELETE /smtp/blockedDomains/{domain} Unblock an existing domain from the list of blocked domains
TransactionalEmailsApi delete_hardbounces POST /smtp/deleteHardbounces Delete hardbounces
TransactionalEmailsApi delete_scheduled_email_by_id DELETE /smtp/email/{identifier} Delete scheduled emails by batchId or messageId
TransactionalEmailsApi delete_smtp_template DELETE /smtp/templates/{templateId} Delete an inactive email template
TransactionalEmailsApi get_aggregated_smtp_report GET /smtp/statistics/aggregatedReport Get your transactional email activity aggregated over a period of time
TransactionalEmailsApi get_blocked_domains GET /smtp/blockedDomains Get the list of blocked domains
TransactionalEmailsApi get_email_event_report GET /smtp/statistics/events Get all your transactional email activity (unaggregated events)
TransactionalEmailsApi get_scheduled_email_by_id GET /smtp/emailStatus/{identifier} Fetch scheduled emails by batchId or messageId
TransactionalEmailsApi get_smtp_report GET /smtp/statistics/reports Get your transactional email activity aggregated per day
TransactionalEmailsApi get_smtp_template GET /smtp/templates/{templateId} Returns the template information
TransactionalEmailsApi get_smtp_templates GET /smtp/templates Get the list of email templates
TransactionalEmailsApi get_transac_blocked_contacts GET /smtp/blockedContacts Get the list of blocked or unsubscribed transactional contacts
TransactionalEmailsApi get_transac_email_content GET /smtp/emails/{uuid} Get the personalized content of a sent transactional email
TransactionalEmailsApi get_transac_emails_list GET /smtp/emails Get the list of transactional emails on the basis of allowed filters
TransactionalEmailsApi send_test_template POST /smtp/templates/{templateId}/sendTest Send a template to your test list
TransactionalEmailsApi send_transac_email POST /smtp/email Send a transactional email
TransactionalEmailsApi smtp_blocked_contacts_email_delete DELETE /smtp/blockedContacts/{email} Unblock or resubscribe a transactional contact
TransactionalEmailsApi smtp_log_identifier_delete DELETE /smtp/log/{identifier} Delete an SMTP transactional log
TransactionalEmailsApi update_smtp_template PUT /smtp/templates/{templateId} Update an email template
TransactionalSmsApi get_sms_events GET /transactionalSMS/statistics/events Get all your SMS activity (unaggregated events)
TransactionalSmsApi get_transac_aggregated_sms_report GET /transactionalSMS/statistics/aggregatedReport Get your SMS activity aggregated over a period of time
TransactionalSmsApi get_transac_sms_report GET /transactionalSMS/statistics/reports Get your SMS activity aggregated per day
TransactionalSmsApi send_async_transactional_sms POST /transactionalSMS/send Send SMS message asynchronously to a mobile number
TransactionalSmsApi send_transac_sms POST /transactionalSMS/sms Send SMS message to a mobile number
TransactionalWhatsAppApi get_whatsapp_event_report GET /whatsapp/statistics/events Get all your WhatsApp activity (unaggregated events)
TransactionalWhatsAppApi send_whatsapp_message POST /whatsapp/sendMessage Send a WhatsApp message
UserApi edit_user_permission POST /organization/user/update/permissions Update permission for a user
UserApi get_invited_users_list GET /organization/invited/users Get the list of all your users
UserApi get_user_permission GET /organization/user/{email}/permissions Check user permission
UserApi inviteuser POST /organization/user/invitation/send Send invitation to user
UserApi put_revoke_user_permission PUT /organization/user/invitation/revoke/{email} Revoke user permission
UserApi putresendcancelinvitation PUT /organization/user/invitation/{action}/{email} Resend / Cancel invitation
WebhooksApi create_webhook POST /webhooks Create a webhook
WebhooksApi delete_webhook DELETE /webhooks/{webhookId} Delete a webhook
WebhooksApi export_webhooks_history POST /webhooks/export Export all webhook events
WebhooksApi get_webhook GET /webhooks/{webhookId} Get a webhook details
WebhooksApi get_webhooks GET /webhooks Get all webhooks
WebhooksApi update_webhook PUT /webhooks/{webhookId} Update a webhook
WhatsAppCampaignsApi create_whats_app_campaign POST /whatsappCampaigns Create and Send a WhatsApp campaign
WhatsAppCampaignsApi create_whats_app_template POST /whatsappCampaigns/template Create a WhatsApp template
WhatsAppCampaignsApi delete_whats_app_campaign DELETE /whatsappCampaigns/{campaignId} Delete a WhatsApp campaign
WhatsAppCampaignsApi get_whats_app_campaign GET /whatsappCampaigns/{campaignId} Get a WhatsApp campaign
WhatsAppCampaignsApi get_whats_app_campaigns GET /whatsappCampaigns Return all your created WhatsApp campaigns
WhatsAppCampaignsApi get_whats_app_config GET /whatsappCampaigns/config Get your WhatsApp API account information
WhatsAppCampaignsApi get_whats_app_templates GET /whatsappCampaigns/template-list Return all your created WhatsApp templates
WhatsAppCampaignsApi send_whats_app_template_approval POST /whatsappCampaigns/template/approval/{templateId} Send your WhatsApp template for approval
WhatsAppCampaignsApi update_whats_app_campaign PUT /whatsappCampaigns/{campaignId} Update a WhatsApp campaign

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

contact@brevo.com

Dependencies

~8–20MB
~275K SLoC