Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full documentation to learn more.
This is the wrapper for the API. It implements all the features of the API v3.
Brevo's API matches the OpenAPI v2 definition. The specification can be downloaded here.
This RUBY package is automatically generated by the Swagger Codegen project and is reviewed and maintained by Brevo:
Add this line to your application's Gemfile:
gem 'brevo'
And then execute:
$ bundle
Or install it yourself as:
$ ( sudo ) gem install brevo
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'brevo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'brevo'
# Setup authorization
Brevo.configure do |config|
# Configure API key authorization: api-key
config.api_key['api-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
config.api_key['partner-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['partner-key'] = 'Bearer'
end
api_instance = Brevo::AccountApi.new
begin
#Get your account information, plan and credits details
result = api_instance.get_account
p result
rescue Brevo::ApiError => e
puts "Exception when calling AccountApi->get_account: #{e}"
end
All URIs are relative to https://api.brevo.com/v3
| Class | Method | HTTP request | Description |
|---|---|---|---|
| Brevo::AccountApi | get_account | GET /account | Get your account information, plan and credits details |
| Brevo::AccountApi | get_account_activity | GET /organization/activities | Get user activity logs |
| Brevo::BalanceApi | begin_transaction | POST /loyalty/balance/programs/{pid}/transactions | Create new transaction |
| Brevo::BalanceApi | cancel_transaction | POST /loyalty/balance/programs/{pid}/transactions/{tid}/cancel | Cancel transaction |
| Brevo::BalanceApi | complete_transaction | POST /loyalty/balance/programs/{pid}/transactions/{tid}/complete | Complete transaction |
| Brevo::BalanceApi | create_balance_limit | POST /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits | Create balance limits |
| Brevo::BalanceApi | create_balance_order | POST /loyalty/balance/programs/{pid}/create-order | Create balance order |
| Brevo::BalanceApi | delete_balance_definition | DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid} | Delete balance definition |
| Brevo::BalanceApi | delete_balance_limit | DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} | Delete balance limit |
| Brevo::BalanceApi | get_balance_definition | GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid} | Get balance definition |
| Brevo::BalanceApi | get_balance_definition_list | GET /loyalty/balance/programs/{pid}/balance-definitions | Get balance definition list |
| Brevo::BalanceApi | get_balance_limit | GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} | Get balance limits |
| Brevo::BalanceApi | get_contact_balances | GET /loyalty/balance/programs/{pid}/contact-balances | Get balance list |
| Brevo::BalanceApi | get_subscription_balances | GET /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances | Get subscription balances |
| Brevo::BalanceApi | loyalty_balance_programs_pid_active_balance_get | GET /loyalty/balance/programs/{pid}/active-balance | Get Active Balances API |
| Brevo::BalanceApi | loyalty_balance_programs_pid_balance_definitions_post | POST /loyalty/balance/programs/{pid}/balance-definitions | Create balance definition |
| Brevo::BalanceApi | loyalty_balance_programs_pid_subscriptions_cid_balances_post | POST /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances | Create subscription balances |
| Brevo::BalanceApi | loyalty_balance_programs_pid_transaction_history_get | GET /loyalty/balance/programs/{pid}/transaction-history | Get Transaction History API |
| Brevo::BalanceApi | update_balance_definition | PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid} | Update balance definition |
| Brevo::BalanceApi | update_balance_limit | PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} | Updates balance limit |
| Brevo::CompaniesApi | companies_get | GET /companies | Get all companies |
| Brevo::CompaniesApi | companies_id_delete | DELETE /companies/{id} | Delete a company |
| Brevo::CompaniesApi | companies_id_get | GET /companies/{id} | Get a company |
| Brevo::CompaniesApi | companies_id_patch | PATCH /companies/{id} | Update a company |
| Brevo::CompaniesApi | companies_import_post | POST /companies/import | Import companies(creation and updation) |
| Brevo::CompaniesApi | companies_link_unlink_id_patch | PATCH /companies/link-unlink/{id} | Link and Unlink company with contacts and deals |
| Brevo::CompaniesApi | companies_post | POST /companies | Create a company |
| Brevo::CompaniesApi | crm_attributes_companies_get | GET /crm/attributes/companies | Get company attributes |
| Brevo::CompaniesApi | crm_attributes_post | POST /crm/attributes | Create a deal/company attribute |
| Brevo::ContactsApi | add_contact_to_list | POST /contacts/lists/{listId}/contacts/add | Add existing contacts to a list |
| Brevo::ContactsApi | create_attribute | POST /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute |
| Brevo::ContactsApi | create_contact | POST /contacts | Create a contact |
| Brevo::ContactsApi | create_doi_contact | POST /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow |
| Brevo::ContactsApi | create_folder | POST /contacts/folders | Create a folder |
| Brevo::ContactsApi | create_list | POST /contacts/lists | Create a list |
| Brevo::ContactsApi | delete_attribute | DELETE /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute |
| Brevo::ContactsApi | delete_contact | DELETE /contacts/{identifier} | Delete a contact |
| Brevo::ContactsApi | delete_folder | DELETE /contacts/folders/{folderId} | Delete a folder (and all its lists) |
| Brevo::ContactsApi | delete_list | DELETE /contacts/lists/{listId} | Delete a list |
| Brevo::ContactsApi | delete_multi_attribute_options | DELETE /contacts/attributes/{attributeType}/{multipleChoiceAttribute}/{multipleChoiceAttributeOption} | Delete a multiple-choice attribute option |
| Brevo::ContactsApi | get_attributes | GET /contacts/attributes | List all attributes |
| Brevo::ContactsApi | get_contact_info | GET /contacts/{identifier} | Get a contact's details |
| Brevo::ContactsApi | get_contact_stats | GET /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact |
| Brevo::ContactsApi | get_contacts | GET /contacts | Get all the contacts |
| Brevo::ContactsApi | get_contacts_from_list | GET /contacts/lists/{listId}/contacts | Get contacts in a list |
| Brevo::ContactsApi | get_folder | GET /contacts/folders/{folderId} | Returns a folder's details |
| Brevo::ContactsApi | get_folder_lists | GET /contacts/folders/{folderId}/lists | Get lists in a folder |
| Brevo::ContactsApi | get_folders | GET /contacts/folders | Get all folders |
| Brevo::ContactsApi | get_list | GET /contacts/lists/{listId} | Get a list's details |
| Brevo::ContactsApi | get_lists | GET /contacts/lists | Get all the lists |
| Brevo::ContactsApi | get_segments | GET /contacts/segments | Get all the Segments |
| Brevo::ContactsApi | import_contacts | POST /contacts/import | Import contacts |
| Brevo::ContactsApi | remove_contact_from_list | POST /contacts/lists/{listId}/contacts/remove | Delete a contact from a list |
| Brevo::ContactsApi | request_contact_export | POST /contacts/export | Export contacts |
| Brevo::ContactsApi | update_attribute | PUT /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute |
| Brevo::ContactsApi | update_batch_contacts | POST /contacts/batch | Update multiple contacts |
| Brevo::ContactsApi | update_contact | PUT /contacts/{identifier} | Update a contact |
| Brevo::ContactsApi | update_folder | PUT /contacts/folders/{folderId} | Update a folder |
| Brevo::ContactsApi | update_list | PUT /contacts/lists/{listId} | Update a list |
| Brevo::ConversationsApi | conversations_agent_online_ping_post | POST /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes |
| Brevo::ConversationsApi | conversations_messages_id_delete | DELETE /conversations/messages/{id} | Delete a message sent by an agent |
| Brevo::ConversationsApi | conversations_messages_id_get | GET /conversations/messages/{id} | Get a message |
| Brevo::ConversationsApi | conversations_messages_id_put | PUT /conversations/messages/{id} | Update a message sent by an agent |
| Brevo::ConversationsApi | conversations_messages_post | POST /conversations/messages | Send a message as an agent |
| Brevo::ConversationsApi | conversations_pushed_messages_id_delete | DELETE /conversations/pushedMessages/{id} | Delete an automated message |
| Brevo::ConversationsApi | conversations_pushed_messages_id_get | GET /conversations/pushedMessages/{id} | Get an automated message |
| Brevo::ConversationsApi | conversations_pushed_messages_id_put | PUT /conversations/pushedMessages/{id} | Update an automated message |
| Brevo::ConversationsApi | conversations_pushed_messages_post | POST /conversations/pushedMessages | Send an automated message to a visitor |
| Brevo::CouponsApi | create_coupon_collection | POST /couponCollections | Create а coupon collection |
| Brevo::CouponsApi | create_coupons | POST /coupons | Create coupons for a coupon collection |
| Brevo::CouponsApi | get_coupon_collection | GET /couponCollections/{id} | Get a coupon collection by id |
| Brevo::CouponsApi | get_coupon_collections | GET /couponCollections | Get all your coupon collections |
| Brevo::CouponsApi | update_coupon_collection | PATCH /couponCollections/{id} | Update a coupon collection by id |
| Brevo::DealsApi | crm_attributes_deals_get | GET /crm/attributes/deals | Get deal attributes |
| Brevo::DealsApi | crm_attributes_post | POST /crm/attributes | Create a deal/company attribute |
| Brevo::DealsApi | crm_deals_get | GET /crm/deals | Get all deals |
| Brevo::DealsApi | crm_deals_id_delete | DELETE /crm/deals/{id} | Delete a deal |
| Brevo::DealsApi | crm_deals_id_get | GET /crm/deals/{id} | Get a deal |
| Brevo::DealsApi | crm_deals_id_patch | PATCH /crm/deals/{id} | Update a deal |
| Brevo::DealsApi | crm_deals_import_post | POST /crm/deals/import | Import deals(creation and updation) |
| Brevo::DealsApi | crm_deals_link_unlink_id_patch | PATCH /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies |
| Brevo::DealsApi | crm_deals_post | POST /crm/deals | Create a deal |
| Brevo::DealsApi | crm_pipeline_details_all_get | GET /crm/pipeline/details/all | Get all pipelines |
| Brevo::DealsApi | crm_pipeline_details_get | GET /crm/pipeline/details | Get pipeline stages |
| Brevo::DealsApi | crm_pipeline_details_pipeline_id_get | GET /crm/pipeline/details/{pipelineID} | Get a pipeline |
| Brevo::DomainsApi | authenticate_domain | PUT /senders/domains/{domainName}/authenticate | Authenticate a domain |
| Brevo::DomainsApi | create_domain | POST /senders/domains | Create a new domain |
| Brevo::DomainsApi | delete_domain | DELETE /senders/domains/{domainName} | Delete a domain |
| Brevo::DomainsApi | get_domain_configuration | GET /senders/domains/{domainName} | Validate domain configuration |
| Brevo::DomainsApi | get_domains | GET /senders/domains | Get the list of all your domains |
| Brevo::EcommerceApi | create_batch_order | POST /orders/status/batch | Create orders in batch |
| Brevo::EcommerceApi | create_order | POST /orders/status | Managing the status of the order |
| Brevo::EcommerceApi | create_update_batch_category | POST /categories/batch | Create categories in batch |
| Brevo::EcommerceApi | create_update_batch_products | POST /products/batch | Create products in batch |
| Brevo::EcommerceApi | create_update_category | POST /categories | Create/Update a category |
| Brevo::EcommerceApi | create_update_product | POST /products | Create/Update a product |
| Brevo::EcommerceApi | ecommerce_activate_post | POST /ecommerce/activate | Activate the eCommerce app |
| Brevo::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 |
| Brevo::EcommerceApi | ecommerce_attribution_metrics_get | GET /ecommerce/attribution/metrics | Get attribution metrics for one or more Brevo campaigns or workflows |
| Brevo::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 |
| Brevo::EcommerceApi | ecommerce_config_display_currency_get | GET /ecommerce/config/displayCurrency | Get the ISO 4217 compliant display currency code for your Brevo account |
| Brevo::EcommerceApi | get_categories | GET /categories | Return all your categories |
| Brevo::EcommerceApi | get_category_info | GET /categories/{id} | Get a category details |
| Brevo::EcommerceApi | get_orders | GET /orders | Get order details |
| Brevo::EcommerceApi | get_product_info | GET /products/{id} | Get a product's details |
| Brevo::EcommerceApi | get_products | GET /products | Return all your products |
| Brevo::EcommerceApi | set_config_display_currency | POST /ecommerce/config/displayCurrency | Set the ISO 4217 compliant display currency code for your Brevo account |
| Brevo::EmailCampaignsApi | create_email_campaign | POST /emailCampaigns | Create an email campaign |
| Brevo::EmailCampaignsApi | delete_email_campaign | DELETE /emailCampaigns/{campaignId} | Delete an email campaign |
| Brevo::EmailCampaignsApi | email_export_recipients | POST /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign |
| Brevo::EmailCampaignsApi | get_ab_test_campaign_result | GET /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results |
| Brevo::EmailCampaignsApi | get_email_campaign | GET /emailCampaigns/{campaignId} | Get an email campaign report |
| Brevo::EmailCampaignsApi | get_email_campaigns | GET /emailCampaigns | Return all your created email campaigns |
| Brevo::EmailCampaignsApi | get_shared_template_url | GET /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url |
| Brevo::EmailCampaignsApi | send_email_campaign_now | POST /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId |
| Brevo::EmailCampaignsApi | send_report | POST /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign |
| Brevo::EmailCampaignsApi | send_test_email | POST /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list |
| Brevo::EmailCampaignsApi | update_campaign_status | PUT /emailCampaigns/{campaignId}/status | Update an email campaign status |
| Brevo::EmailCampaignsApi | update_email_campaign | PUT /emailCampaigns/{campaignId} | Update an email campaign |
| Brevo::EmailCampaignsApi | upload_image_to_gallery | POST /emailCampaigns/images | Upload an image to your account's image gallery |
| Brevo::EventsApi | create_event | POST /events | Create an event |
| Brevo::ExternalFeedsApi | create_external_feed | POST /feeds | Create an external feed |
| Brevo::ExternalFeedsApi | delete_external_feed | DELETE /feeds/{uuid} | Delete an external feed |
| Brevo::ExternalFeedsApi | get_all_external_feeds | GET /feeds | Fetch all external feeds |
| Brevo::ExternalFeedsApi | get_external_feed_by_uuid | GET /feeds/{uuid} | Get an external feed by UUID |
| Brevo::ExternalFeedsApi | update_external_feed | PUT /feeds/{uuid} | Update an external feed |
| Brevo::FilesApi | crm_files_get | GET /crm/files | Get all files |
| Brevo::FilesApi | crm_files_id_data_get | GET /crm/files/{id}/data | Get file details |
| Brevo::FilesApi | crm_files_id_delete | DELETE /crm/files/{id} | Delete a file |
| Brevo::FilesApi | crm_files_id_get | GET /crm/files/{id} | Download a file |
| Brevo::FilesApi | crm_files_post | POST /crm/files | Upload a file |
| Brevo::InboundParsingApi | get_inbound_email_attachment | GET /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token. |
| Brevo::InboundParsingApi | get_inbound_email_events | GET /inbound/events | Get the list of all the events for the received emails. |
| Brevo::InboundParsingApi | get_inbound_email_events_by_uuid | GET /inbound/events/{uuid} | Fetch all events history for one particular received email. |
| Brevo::MasterAccountApi | corporate_group_id_delete | DELETE /corporate/group/{id} | Delete a group |
| Brevo::MasterAccountApi | corporate_group_id_get | GET /corporate/group/{id} | GET a group details |
| Brevo::MasterAccountApi | corporate_group_id_put | PUT /corporate/group/{id} | Update a group of sub-accounts |
| Brevo::MasterAccountApi | corporate_group_post | POST /corporate/group | Create a new group of sub-accounts |
| Brevo::MasterAccountApi | corporate_group_unlink_group_id_sub_accounts_put | PUT /corporate/group/unlink/{groupId}/subAccounts | Delete sub-account from group |
| Brevo::MasterAccountApi | corporate_ip_get | GET /corporate/ip | List of all IPs |
| Brevo::MasterAccountApi | corporate_master_account_get | GET /corporate/masterAccount | Get the details of requested master account |
| Brevo::MasterAccountApi | corporate_sso_token_post | POST /corporate/ssoToken | Generate SSO token to access admin account |
| Brevo::MasterAccountApi | corporate_sub_account_get | GET /corporate/subAccount | Get the list of all the sub-accounts of the master account. |
| Brevo::MasterAccountApi | corporate_sub_account_id_applications_toggle_put | PUT /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s) |
| Brevo::MasterAccountApi | corporate_sub_account_id_delete | DELETE /corporate/subAccount/{id} | Delete a sub-account |
| Brevo::MasterAccountApi | corporate_sub_account_id_get | GET /corporate/subAccount/{id} | Get sub-account details |
| Brevo::MasterAccountApi | corporate_sub_account_id_plan_put | PUT /corporate/subAccount/{id}/plan | Update sub-account plan |
| Brevo::MasterAccountApi | corporate_sub_account_ip_associate_post | POST /corporate/subAccount/ip/associate | Associate an IP to sub-accounts |
| Brevo::MasterAccountApi | corporate_sub_account_ip_dissociate_put | PUT /corporate/subAccount/ip/dissociate | Dissociate an IP from sub-accounts |
| Brevo::MasterAccountApi | corporate_sub_account_key_post | POST /corporate/subAccount/key | Create an API key for a sub-account |
| Brevo::MasterAccountApi | corporate_sub_account_post | POST /corporate/subAccount | Create a new sub-account under a master account. |
| Brevo::MasterAccountApi | corporate_sub_account_sso_token_post | POST /corporate/subAccount/ssoToken | Generate SSO token to access sub-account |
| Brevo::MasterAccountApi | corporate_sub_accounts_plan_put | PUT /corporate/subAccounts/plan | Update sub-accounts plan |
| Brevo::MasterAccountApi | corporate_user_email_permissions_put | PUT /corporate/user/{email}/permissions | Change admin user permissions |
| Brevo::MasterAccountApi | corporate_user_invitation_action_email_put | PUT /corporate/user/invitation/{action}/{email} | Resend / cancel admin user invitation |
| Brevo::MasterAccountApi | corporate_user_revoke_email_delete | DELETE /corporate/user/revoke/{email} | Revoke an admin user |
| Brevo::MasterAccountApi | get_account_activity | GET /organization/activities | Get user activity logs |
| Brevo::MasterAccountApi | get_corporate_invited_users_list | GET /corporate/invited/users | Get the list of all admin users |
| Brevo::MasterAccountApi | get_corporate_user_permission | GET /corporate/user/{email}/permissions | Check admin user permissions |
| Brevo::MasterAccountApi | get_sub_account_groups | GET /corporate/groups | Get the list of groups |
| Brevo::MasterAccountApi | invite_admin_user | POST /corporate/user/invitation/send | Send invitation to an admin user |
| Brevo::NotesApi | crm_notes_get | GET /crm/notes | Get all notes |
| Brevo::NotesApi | crm_notes_id_delete | DELETE /crm/notes/{id} | Delete a note |
| Brevo::NotesApi | crm_notes_id_get | GET /crm/notes/{id} | Get a note |
| Brevo::NotesApi | crm_notes_id_patch | PATCH /crm/notes/{id} | Update a note |
| Brevo::NotesApi | crm_notes_post | POST /crm/notes | Create a note |
| Brevo::PaymentsApi | create_payment_request | POST /payments/requests | Create a payment request |
| Brevo::PaymentsApi | delete_payment_request | DELETE /payments/requests/{id} | Delete a payment request. |
| Brevo::PaymentsApi | get_payment_request | GET /payments/requests/{id} | Get payment request details |
| Brevo::ProcessApi | get_process | GET /processes/{processId} | Return the informations for a process |
| Brevo::ProcessApi | get_processes | GET /processes | Return all the processes for your account |
| Brevo::ProgramApi | create_new_lp | POST /loyalty/config/programs | Create loyalty program |
| Brevo::ProgramApi | delete_contact_members | DELETE /loyalty/config/programs/{pid}/subscription-members | Delete subscription member |
| Brevo::ProgramApi | delete_loyalty_program | DELETE /loyalty/config/programs/{pid} | Delete Loyalty Program |
| Brevo::ProgramApi | get_loyalty_program_info | GET /loyalty/config/programs/{pid} | Get loyalty program Info |
| Brevo::ProgramApi | get_lp_list | GET /loyalty/config/programs | Get loyalty program list |
| Brevo::ProgramApi | get_parameter_subscription_info | GET /loyalty/config/programs/{pid}/account-info | Get Subscription Data |
| Brevo::ProgramApi | partially_update_loyalty_program | PATCH /loyalty/config/programs/{pid} | Partially update loyalty program |
| Brevo::ProgramApi | publish_loyalty_program | POST /loyalty/config/programs/{pid}/publish | Publish loyalty program |
| Brevo::ProgramApi | subscribe_member_to_a_subscription | POST /loyalty/config/programs/{pid}/subscription-members | Create subscription member |
| Brevo::ProgramApi | subscribe_to_loyalty_program | POST /loyalty/config/programs/{pid}/subscriptions | Create subscription |
| Brevo::ProgramApi | update_loyalty_program | PUT /loyalty/config/programs/{pid} | Update loyalty program |
| Brevo::RewardApi | get_code_count | GET /loyalty/offer/programs/{pid}/code-pools/{cpid}/codes-count | Get code count |
| Brevo::RewardApi | loyalty_offer_programs_pid_offers_get | GET /loyalty/offer/programs/{pid}/offers | Get Reward Page API |
| Brevo::RewardApi | loyalty_offer_programs_pid_offers_post | POST /loyalty/offer/programs/{pid}/offers | Create a reward |
| Brevo::RewardApi | loyalty_offer_programs_pid_rewards_attribute_post | POST /loyalty/offer/programs/{pid}/rewards/attribute | Create a voucher |
| Brevo::RewardApi | loyalty_offer_programs_pid_rewards_redeem_post | POST /loyalty/offer/programs/{pid}/rewards/redeem | Create redeem voucher request |
| Brevo::RewardApi | loyalty_offer_programs_pid_rewards_redeem_tid_complete_post | POST /loyalty/offer/programs/{pid}/rewards/redeem/{tid}/complete | Complete redeem voucher request |
| Brevo::RewardApi | loyalty_offer_programs_pid_rewards_revoke_delete | DELETE /loyalty/offer/programs/{pid}/rewards/revoke | Revoke vouchers |
| Brevo::RewardApi | loyalty_offer_programs_pid_rewards_rid_get | GET /loyalty/offer/programs/{pid}/rewards/{rid} | Get reward information |
| Brevo::RewardApi | loyalty_offer_programs_pid_rewards_validate_post | POST /loyalty/offer/programs/{pid}/rewards/validate | Validate a reward |
| Brevo::RewardApi | loyalty_offer_programs_pid_vouchers_get | GET /loyalty/offer/programs/{pid}/vouchers | Get voucher for a contact |
| Brevo::SMSCampaignsApi | create_sms_campaign | POST /smsCampaigns | Creates an SMS campaign |
| Brevo::SMSCampaignsApi | delete_sms_campaign | DELETE /smsCampaigns/{campaignId} | Delete an SMS campaign |
| Brevo::SMSCampaignsApi | get_sms_campaign | GET /smsCampaigns/{campaignId} | Get an SMS campaign |
| Brevo::SMSCampaignsApi | get_sms_campaigns | GET /smsCampaigns | Returns the information for all your created SMS campaigns |
| Brevo::SMSCampaignsApi | request_sms_recipient_export | POST /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients |
| Brevo::SMSCampaignsApi | send_sms_campaign_now | POST /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately |
| Brevo::SMSCampaignsApi | send_sms_report | POST /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report |
| Brevo::SMSCampaignsApi | send_test_sms | POST /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign |
| Brevo::SMSCampaignsApi | update_sms_campaign | PUT /smsCampaigns/{campaignId} | Update an SMS campaign |
| Brevo::SMSCampaignsApi | update_sms_campaign_status | PUT /smsCampaigns/{campaignId}/status | Update a campaign's status |
| Brevo::SendersApi | create_sender | POST /senders | Create a new sender |
| Brevo::SendersApi | delete_sender | DELETE /senders/{senderId} | Delete a sender |
| Brevo::SendersApi | get_ips | GET /senders/ips | Get all the dedicated IPs for your account |
| Brevo::SendersApi | get_ips_from_sender | GET /senders/{senderId}/ips | Get all the dedicated IPs for a sender |
| Brevo::SendersApi | get_senders | GET /senders | Get the list of all your senders |
| Brevo::SendersApi | update_sender | PUT /senders/{senderId} | Update a sender |
| Brevo::SendersApi | validate_sender_by_otp | PUT /senders/{senderId}/validate | Update a sender |
| Brevo::TasksApi | crm_tasks_get | GET /crm/tasks | Get all tasks |
| Brevo::TasksApi | crm_tasks_id_delete | DELETE /crm/tasks/{id} | Delete a task |
| Brevo::TasksApi | crm_tasks_id_get | GET /crm/tasks/{id} | Get a task |
| Brevo::TasksApi | crm_tasks_id_patch | PATCH /crm/tasks/{id} | Update a task |
| Brevo::TasksApi | crm_tasks_post | POST /crm/tasks | Create a task |
| Brevo::TasksApi | crm_tasktypes_get | GET /crm/tasktypes | Get all task types |
| Brevo::TierApi | add_subscription_to_tier | POST /loyalty/tier/programs/{pid}/contacts/{cid}/tiers/{tid} | Assign a tier |
| Brevo::TierApi | create_tier_for_tier_group | POST /loyalty/tier/programs/{pid}/tier-groups/{gid}/tiers | Create a tier |
| Brevo::TierApi | create_tier_group | POST /loyalty/tier/programs/{pid}/tier-groups | Create a tier group |
| Brevo::TierApi | delete_tier | DELETE /loyalty/tier/programs/{pid}/tiers/{tid} | Delete tier |
| Brevo::TierApi | delete_tier_group | DELETE /loyalty/tier/programs/{pid}/tier-groups/{gid} | Delete tier group |
| Brevo::TierApi | get_list_of_tier_groups | GET /loyalty/tier/programs/{pid}/tier-groups | List tier groups |
| Brevo::TierApi | get_loyalty_program_tier | GET /loyalty/tier/programs/{pid}/tiers | List tiers |
| Brevo::TierApi | get_tier_group | GET /loyalty/tier/programs/{pid}/tier-groups/{gid} | Get tier group |
| Brevo::TierApi | update_tier | PUT /loyalty/tier/programs/{pid}/tiers/{tid} | Update tier |
| Brevo::TierApi | update_tier_group | PUT /loyalty/tier/programs/{pid}/tier-groups/{gid} | Update tier group |
| Brevo::TransactionalEmailsApi | block_new_domain | POST /smtp/blockedDomains | Add a new domain to the list of blocked domains |
| Brevo::TransactionalEmailsApi | create_smtp_template | POST /smtp/templates | Create an email template |
| Brevo::TransactionalEmailsApi | delete_blocked_domain | DELETE /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains |
| Brevo::TransactionalEmailsApi | delete_hardbounces | POST /smtp/deleteHardbounces | Delete hardbounces |
| Brevo::TransactionalEmailsApi | delete_scheduled_email_by_id | DELETE /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId |
| Brevo::TransactionalEmailsApi | delete_smtp_template | DELETE /smtp/templates/{templateId} | Delete an inactive email template |
| Brevo::TransactionalEmailsApi | get_aggregated_smtp_report | GET /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time |
| Brevo::TransactionalEmailsApi | get_blocked_domains | GET /smtp/blockedDomains | Get the list of blocked domains |
| Brevo::TransactionalEmailsApi | get_email_event_report | GET /smtp/statistics/events | Get all your transactional email activity (unaggregated events) |
| Brevo::TransactionalEmailsApi | get_scheduled_email_by_batch_id | GET /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId |
| Brevo::TransactionalEmailsApi | get_scheduled_email_by_message_id | GET /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId |
| Brevo::TransactionalEmailsApi | get_smtp_report | GET /smtp/statistics/reports | Get your transactional email activity aggregated per day |
| Brevo::TransactionalEmailsApi | get_smtp_template | GET /smtp/templates/{templateId} | Returns the template information |
| Brevo::TransactionalEmailsApi | get_smtp_templates | GET /smtp/templates | Get the list of email templates |
| Brevo::TransactionalEmailsApi | get_transac_blocked_contacts | GET /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts |
| Brevo::TransactionalEmailsApi | get_transac_email_content | GET /smtp/emails/{uuid} | Get the personalized content of a sent transactional email |
| Brevo::TransactionalEmailsApi | get_transac_emails_list | GET /smtp/emails | Get the list of transactional emails on the basis of allowed filters |
| Brevo::TransactionalEmailsApi | post_preview_smtp_email_templates | POST /smtp/template/preview | Generate the rendered preview of transactional template |
| Brevo::TransactionalEmailsApi | send_test_template | POST /smtp/templates/{templateId}/sendTest | Send a template to your test list |
| Brevo::TransactionalEmailsApi | send_transac_email | POST /smtp/email | Send a transactional email |
| Brevo::TransactionalEmailsApi | smtp_blocked_contacts_email_delete | DELETE /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact |
| Brevo::TransactionalEmailsApi | smtp_log_identifier_delete | DELETE /smtp/log/{identifier} | Delete an SMTP transactional log |
| Brevo::TransactionalEmailsApi | update_smtp_template | PUT /smtp/templates/{templateId} | Update an email template |
| Brevo::TransactionalSMSApi | get_sms_events | GET /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) |
| Brevo::TransactionalSMSApi | get_transac_aggregated_sms_report | GET /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time |
| Brevo::TransactionalSMSApi | get_transac_sms_report | GET /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day |
| Brevo::TransactionalSMSApi | send_async_transactional_sms | POST /transactionalSMS/send | Send SMS message asynchronously to a mobile number |
| Brevo::TransactionalSMSApi | send_transac_sms | POST /transactionalSMS/sms | Send SMS message to a mobile number |
| Brevo::TransactionalWhatsAppApi | get_whatsapp_event_report | GET /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events) |
| Brevo::TransactionalWhatsAppApi | send_whatsapp_message | POST /whatsapp/sendMessage | Send a WhatsApp message |
| Brevo::UserApi | edit_user_permission | POST /organization/user/update/permissions | Update permission for a user |
| Brevo::UserApi | get_invited_users_list | GET /organization/invited/users | Get the list of all your users |
| Brevo::UserApi | get_user_permission | GET /organization/user/{email}/permissions | Check user permission |
| Brevo::UserApi | inviteuser | POST /organization/user/invitation/send | Send invitation to user |
| Brevo::UserApi | put_revoke_user_permission | PUT /organization/user/invitation/revoke/{email} | Revoke user permission |
| Brevo::UserApi | putresendcancelinvitation | PUT /organization/user/invitation/{action}/{email} | Resend / Cancel invitation |
| Brevo::WebhooksApi | create_webhook | POST /webhooks | Create a webhook |
| Brevo::WebhooksApi | delete_webhook | DELETE /webhooks/{webhookId} | Delete a webhook |
| Brevo::WebhooksApi | export_webhooks_history | POST /webhooks/export | Export all webhook events |
| Brevo::WebhooksApi | get_webhook | GET /webhooks/{webhookId} | Get a webhook details |
| Brevo::WebhooksApi | get_webhooks | GET /webhooks | Get all webhooks |
| Brevo::WebhooksApi | update_webhook | PUT /webhooks/{webhookId} | Update a webhook |
| Brevo::WhatsAppCampaignsApi | create_whats_app_campaign | POST /whatsappCampaigns | Create and Send a WhatsApp campaign |
| Brevo::WhatsAppCampaignsApi | create_whats_app_template | POST /whatsppCampaigns/template | Create a WhatsApp template |
| Brevo::WhatsAppCampaignsApi | delete_whats_app_campaign | DELETE /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign |
| Brevo::WhatsAppCampaignsApi | get_whats_app_campaign | GET /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign |
| Brevo::WhatsAppCampaignsApi | get_whats_app_campaigns | GET /whatsappCampaigns | Return all your created WhatsApp campaigns |
| Brevo::WhatsAppCampaignsApi | get_whats_app_config | GET /whatsappCampaigns/config | Get your WhatsApp API account information |
| Brevo::WhatsAppCampaignsApi | get_whats_app_templates | GET /whatsappCampaigns/template-list | Return all your created WhatsApp templates |
| Brevo::WhatsAppCampaignsApi | send_whats_app_template_approval | POST /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval |
| Brevo::WhatsAppCampaignsApi | update_whats_app_campaign | PUT /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign |
Be sure to visit the Brevo official documentation website for additional information about our API.
If you find a bug, please post the issue on Github.
As always, if you need additional assistance, drop us a note here.
Please follow camelCase convention for variables in the API's. For example, use customVariable instead of custom_variable.
FAQs
Unknown package
We found that brevo demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.