Файловый менеджер - Редактировать - /home/clickysoft/public_html/jm5-api.clickysoft.net/vendor/getbrevo/brevo-php/README.md
Назад
# Brevo's API v3 Php Library Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) 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](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/swagger_definition.yml). This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by Brevo: - API version: 3.0.0 - Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit [https://account.brevo.com/support](https://account.brevo.com/support) ## Requirements PHP 5.6 and later ## Installation & Usage ### Composer To install the bindings via [Composer](http://getcomposer.org/): Create a ```composer.json``` file in any directory & add below code in composer.json file. ``` { "require": { "getbrevo/brevo-php": "1.x.x" } } ``` Then run below commands in the same directory ``` composer require getbrevo/brevo-php "1.x.x" ``` Further do: * run ``composer install`` to get these dependencies added to your vendor directory * add the autoloader to your application with this line: ``require("vendor/autoload.php")`` ## Tests To run the unit tests: ``` composer install ./vendor/bin/phpunit ``` ## Getting Started Please follow the [installation procedure](#installation--usage) and then run the following: ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); try { $result = $apiInstance->getAccount(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL; } ?> ``` ## Documentation for API Endpoints All URIs are relative to *https://api.brevo.com/v3* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AccountApi* | [**getAccount**](docs/Api/AccountApi.md#getaccount) | **GET** /account | Get your account information, plan and credits details *AccountApi* | [**getAccountActivity**](docs/Api/AccountApi.md#getaccountactivity) | **GET** /organization/activities | Get user activity logs *CompaniesApi* | [**companiesAttributesGet**](docs/Api/CompaniesApi.md#companiesattributesget) | **GET** /companies/attributes | Get company attributes *CompaniesApi* | [**companiesGet**](docs/Api/CompaniesApi.md#companiesget) | **GET** /companies | Get all companies *CompaniesApi* | [**companiesIdDelete**](docs/Api/CompaniesApi.md#companiesiddelete) | **DELETE** /companies/{id} | Delete a company *CompaniesApi* | [**companiesIdGet**](docs/Api/CompaniesApi.md#companiesidget) | **GET** /companies/{id} | Get a company *CompaniesApi* | [**companiesIdPatch**](docs/Api/CompaniesApi.md#companiesidpatch) | **PATCH** /companies/{id} | Update a company *CompaniesApi* | [**companiesLinkUnlinkIdPatch**](docs/Api/CompaniesApi.md#companieslinkunlinkidpatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals *CompaniesApi* | [**companiesPost**](docs/Api/CompaniesApi.md#companiespost) | **POST** /companies | Create a company *AttributesApi* | [**createAttribute**](docs/Api/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *AttributesApi* | [**deleteAttribute**](docs/Api/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *AttributesApi* | [**getAttributes**](docs/Api/AttributesApi.md#getattributes) | **GET** /contacts/attributes | List all attributes *AttributesApi* | [**updateAttribute**](docs/Api/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute *CRMApi* | [**crmNotesGet**](docs/Api/CRMApi.md#crmnotesget) | **GET** /crm/notes | Get all notes *CRMApi* | [**crmNotesIdDelete**](docs/Api/CRMApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note *CRMApi* | [**crmNotesIdGet**](docs/Api/CRMApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note *CRMApi* | [**crmNotesIdPatch**](docs/Api/CRMApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note *CRMApi* | [**crmNotesPost**](docs/Api/CRMApi.md#crmnotespost) | **POST** /crm/notes | Create a note *CRMApi* | [**crmTasksGet**](docs/Api/CRMApi.md#crmtasksget) | **GET** /crm/tasks | Get all tasks *CRMApi* | [**crmTasksIdDelete**](docs/Api/CRMApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task *CRMApi* | [**crmTasksIdGet**](docs/Api/CRMApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task *CRMApi* | [**crmTasksIdPatch**](docs/Api/CRMApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task *CRMApi* | [**crmTasksPost**](docs/Api/CRMApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task *CRMApi* | [**crmTasktypesGet**](docs/Api/CRMApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types *ContactsApi* | [**addContactToList**](docs/Api/ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ContactsApi* | [**createAttribute**](docs/Api/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *ContactsApi* | [**createContact**](docs/Api/ContactsApi.md#createcontact) | **POST** /contacts | Create a contact *ContactsApi* | [**createDoiContact**](docs/Api/ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow *ContactsApi* | [**createFolder**](docs/Api/ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder *ContactsApi* | [**createList**](docs/Api/ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list *ContactsApi* | [**deleteAttribute**](docs/Api/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *ContactsApi* | [**deleteContact**](docs/Api/ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | Delete a contact *ContactsApi* | [**deleteFolder**](docs/Api/ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *ContactsApi* | [**deleteList**](docs/Api/ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list *ContactsApi* | [**getAttributes**](docs/Api/ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes *ContactsApi* | [**getContactInfo**](docs/Api/ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details *ContactsApi* | [**getContactStats**](docs/Api/ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact *ContactsApi* | [**getContacts**](docs/Api/ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts *ContactsApi* | [**getContactsFromList**](docs/Api/ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list *ContactsApi* | [**getFolder**](docs/Api/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details *ContactsApi* | [**getFolderLists**](docs/Api/ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder *ContactsApi* | [**getFolders**](docs/Api/ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all folders *ContactsApi* | [**getList**](docs/Api/ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details *ContactsApi* | [**getLists**](docs/Api/ContactsApi.md#getlists) | **GET** /contacts/lists | Get all the lists *ContactsApi* | [**getSegments**](docs/Api/ContactsApi.md#getsegments) | **GET** /contacts/segments | Get all the Segments *ContactsApi* | [**importContacts**](docs/Api/ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts *ContactsApi* | [**removeContactFromList**](docs/Api/ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ContactsApi* | [**requestContactExport**](docs/Api/ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts *ContactsApi* | [**updateAttribute**](docs/Api/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute *ContactsApi* | [**updateBatchContacts**](docs/Api/ContactsApi.md#updatebatchcontacts) | **POST** /contacts/batch | Update multiple contacts *ContactsApi* | [**updateContact**](docs/Api/ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | Update a contact *ContactsApi* | [**updateFolder**](docs/Api/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder *ContactsApi* | [**updateList**](docs/Api/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *ConversationsApi* | [**conversationsAgentOnlinePingPost**](docs/Api/ConversationsApi.md#conversationsagentonlinepingpost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes *ConversationsApi* | [**conversationsMessagesIdDelete**](docs/Api/ConversationsApi.md#conversationsmessagesiddelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent *ConversationsApi* | [**conversationsMessagesIdGet**](docs/Api/ConversationsApi.md#conversationsmessagesidget) | **GET** /conversations/messages/{id} | Get a message *ConversationsApi* | [**conversationsMessagesIdPut**](docs/Api/ConversationsApi.md#conversationsmessagesidput) | **PUT** /conversations/messages/{id} | Update a message sent by an agent *ConversationsApi* | [**conversationsMessagesPost**](docs/Api/ConversationsApi.md#conversationsmessagespost) | **POST** /conversations/messages | Send a message as an agent *ConversationsApi* | [**conversationsPushedMessagesIdDelete**](docs/Api/ConversationsApi.md#conversationspushedmessagesiddelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message *ConversationsApi* | [**conversationsPushedMessagesIdGet**](docs/Api/ConversationsApi.md#conversationspushedmessagesidget) | **GET** /conversations/pushedMessages/{id} | Get an automated message *ConversationsApi* | [**conversationsPushedMessagesIdPut**](docs/Api/ConversationsApi.md#conversationspushedmessagesidput) | **PUT** /conversations/pushedMessages/{id} | Update an automated message *ConversationsApi* | [**conversationsPushedMessagesPost**](docs/Api/ConversationsApi.md#conversationspushedmessagespost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor *CouponsApi* | [**createCouponCollection**](docs/Api/CouponsApi.md#createcouponcollection) | **POST** /couponCollections | Create а coupon collection *CouponsApi* | [**createCoupons**](docs/Api/CouponsApi.md#createcoupons) | **POST** /coupons | Create coupons for a coupon collection *CouponsApi* | [**getCouponCollection**](docs/Api/CouponsApi.md#getcouponcollection) | **GET** /couponCollections/{id} | Get a coupon collection by id *CouponsApi* | [**getCouponCollections**](docs/Api/CouponsApi.md#getcouponcollections) | **GET** /couponCollections | Get all your coupon collections *CouponsApi* | [**updateCouponCollection**](docs/Api/CouponsApi.md#updatecouponcollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id *DealsApi* | [**crmAttributesDealsGet**](docs/Api/DealsApi.md#crmattributesdealsget) | **GET** /crm/attributes/deals | Get deal attributes *DealsApi* | [**crmDealsGet**](docs/Api/DealsApi.md#crmdealsget) | **GET** /crm/deals | Get all deals *DealsApi* | [**crmDealsIdDelete**](docs/Api/DealsApi.md#crmdealsiddelete) | **DELETE** /crm/deals/{id} | Delete a deal *DealsApi* | [**crmDealsIdGet**](docs/Api/DealsApi.md#crmdealsidget) | **GET** /crm/deals/{id} | Get a deal *DealsApi* | [**crmDealsIdPatch**](docs/Api/DealsApi.md#crmdealsidpatch) | **PATCH** /crm/deals/{id} | Update a deal *DealsApi* | [**crmDealsLinkUnlinkIdPatch**](docs/Api/DealsApi.md#crmdealslinkunlinkidpatch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies *DealsApi* | [**crmDealsPost**](docs/Api/DealsApi.md#crmdealspost) | **POST** /crm/deals | Create a deal *DealsApi* | [**crmPipelineDetailsAllGet**](docs/Api/DealsApi.md#crmpipelinedetailsallget) | **GET** /crm/pipeline/details/all | Get all pipelines *DealsApi* | [**crmPipelineDetailsGet**](docs/Api/DealsApi.md#crmpipelinedetailsget) | **GET** /crm/pipeline/details | Get pipeline stages *DealsApi* | [**crmPipelineDetailsPipelineIDGet**](docs/Api/DealsApi.md#crmpipelinedetailspipelineidget) | **GET** /crm/pipeline/details/{pipelineID} | Get a pipeline *DomainsApi* | [**authenticateDomain**](docs/Api/DomainsApi.md#authenticatedomain) | **PUT** /senders/domains/{domainName}/authenticate | Authenticate a domain *DomainsApi* | [**createDomain**](docs/Api/DomainsApi.md#createdomain) | **POST** /senders/domains | Create a new domain *DomainsApi* | [**deleteDomain**](docs/Api/DomainsApi.md#deletedomain) | **DELETE** /senders/domains/{domainName} | Delete a domain *DomainsApi* | [**getDomainConfiguration**](docs/Api/DomainsApi.md#getdomainconfiguration) | **GET** /senders/domains/{domainName} | Validate domain configuration *DomainsApi* | [**getDomains**](docs/Api/DomainsApi.md#getdomains) | **GET** /senders/domains | Get the list of all your domains *EcommerceApi* | [**createBatchOrder**](docs/Api/EcommerceApi.md#createbatchorder) | **POST** /orders/status/batch | Create orders in batch *EcommerceApi* | [**createOrder**](docs/Api/EcommerceApi.md#createorder) | **POST** /orders/status | Managing the status of the order *EcommerceApi* | [**createUpdateBatchCategory**](docs/Api/EcommerceApi.md#createupdatebatchcategory) | **POST** /categories/batch | Create categories in batch *EcommerceApi* | [**createUpdateBatchProducts**](docs/Api/EcommerceApi.md#createupdatebatchproducts) | **POST** /products/batch | Create products in batch *EcommerceApi* | [**createUpdateCategory**](docs/Api/EcommerceApi.md#createupdatecategory) | **POST** /categories | Create/Update a category *EcommerceApi* | [**createUpdateProduct**](docs/Api/EcommerceApi.md#createupdateproduct) | **POST** /products | Create/Update a product *EcommerceApi* | [**ecommerceActivatePost**](docs/Api/EcommerceApi.md#ecommerceactivatepost) | **POST** /ecommerce/activate | Activate the eCommerce app *EcommerceApi* | [**getCategories**](docs/Api/EcommerceApi.md#getcategories) | **GET** /categories | Return all your categories *EcommerceApi* | [**getCategoryInfo**](docs/Api/EcommerceApi.md#getcategoryinfo) | **GET** /categories/{id} | Get a category details *EcommerceApi* | [**getProductInfo**](docs/Api/EcommerceApi.md#getproductinfo) | **GET** /products/{id} | Get a product's details *EcommerceApi* | [**getProducts**](docs/Api/EcommerceApi.md#getproducts) | **GET** /products | Return all your products *EmailCampaignsApi* | [**createEmailCampaign**](docs/Api/EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign *EmailCampaignsApi* | [**deleteEmailCampaign**](docs/Api/EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign *EmailCampaignsApi* | [**emailExportRecipients**](docs/Api/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign *EmailCampaignsApi* | [**getAbTestCampaignResult**](docs/Api/EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results *EmailCampaignsApi* | [**getEmailCampaign**](docs/Api/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report *EmailCampaignsApi* | [**getEmailCampaigns**](docs/Api/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created email campaigns *EmailCampaignsApi* | [**getSharedTemplateUrl**](docs/Api/EmailCampaignsApi.md#getsharedtemplateurl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url *EmailCampaignsApi* | [**sendEmailCampaignNow**](docs/Api/EmailCampaignsApi.md#sendemailcampaignnow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId *EmailCampaignsApi* | [**sendReport**](docs/Api/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign *EmailCampaignsApi* | [**sendTestEmail**](docs/Api/EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list *EmailCampaignsApi* | [**updateCampaignStatus**](docs/Api/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status *EmailCampaignsApi* | [**updateEmailCampaign**](docs/Api/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign *EmailCampaignsApi* | [**uploadImageToGallery**](docs/Api/EmailCampaignsApi.md#uploadimagetogallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery *FoldersApi* | [**createFolder**](docs/Api/FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder *FoldersApi* | [**deleteFolder**](docs/Api/FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *FoldersApi* | [**getFolder**](docs/Api/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details *FoldersApi* | [**getFolderLists**](docs/Api/FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder *FoldersApi* | [**getFolders**](docs/Api/FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all folders *FoldersApi* | [**updateFolder**](docs/Api/FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder *ExternalFeedsApi* | [**createExternalFeed**](docs/Api/ExternalFeedsApi.md#createexternalfeed) | **POST** /feeds | Create an external feed *ExternalFeedsApi* | [**deleteExternalFeed**](docs/Api/ExternalFeedsApi.md#deleteexternalfeed) | **DELETE** /feeds/{uuid} | Delete an external feed *ExternalFeedsApi* | [**getAllExternalFeeds**](docs/Api/ExternalFeedsApi.md#getallexternalfeeds) | **GET** /feeds | Fetch all external feeds *ExternalFeedsApi* | [**getExternalFeedByUUID**](docs/Api/ExternalFeedsApi.md#getexternalfeedbyuuid) | **GET** /feeds/{uuid} | Get an external feed by UUID *ExternalFeedsApi* | [**updateExternalFeed**](docs/Api/ExternalFeedsApi.md#updateexternalfeed) | **PUT** /feeds/{uuid} | Update an external feed *FilesApi* | [**crmFilesGet**](docs/Api/FilesApi.md#crmfilesget) | **GET** /crm/files | Get all files *FilesApi* | [**crmFilesIdDataGet**](docs/Api/FilesApi.md#crmfilesiddataget) | **GET** /crm/files/{id}/data | Get file details *FilesApi* | [**crmFilesIdDelete**](docs/Api/FilesApi.md#crmfilesiddelete) | **DELETE** /crm/files/{id} | Delete a file *FilesApi* | [**crmFilesIdGet**](docs/Api/FilesApi.md#crmfilesidget) | **GET** /crm/files/{id} | Download a file *FilesApi* | [**crmFilesPost**](docs/Api/FilesApi.md#crmfilespost) | **POST** /crm/files | Upload a file *InboundParsingApi* | [**getInboundEmailAttachment**](docs/Api/InboundParsingApi.md#getinboundemailattachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token. *InboundParsingApi* | [**getInboundEmailEvents**](docs/Api/InboundParsingApi.md#getinboundemailevents) | **GET** /inbound/events | Get the list of all the events for the received emails. *InboundParsingApi* | [**getInboundEmailEventsByUuid**](docs/Api/InboundParsingApi.md#getinboundemaileventsbyuuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email. *ListsApi* | [**addContactToList**](docs/Api/ListsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ListsApi* | [**createList**](docs/Api/ListsApi.md#createlist) | **POST** /contacts/lists | Create a list *ListsApi* | [**deleteList**](docs/Api/ListsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list *ListsApi* | [**getContactsFromList**](docs/Api/ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list *ListsApi* | [**getFolderLists**](docs/Api/ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder *ListsApi* | [**getList**](docs/Api/ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details *ListsApi* | [**getLists**](docs/Api/ListsApi.md#getlists) | **GET** /contacts/lists | Get all the lists *ListsApi* | [**removeContactFromList**](docs/Api/ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ListsApi* | [**updateList**](docs/Api/ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *MasterAccountApi* | [**corporateMasterAccountGet**](docs/Api/MasterAccountApi.md#corporatemasteraccountget) | **GET** /corporate/masterAccount | Get the details of requested master account *MasterAccountApi* | [**corporateSubAccountGet**](docs/Api/MasterAccountApi.md#corporatesubaccountget) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account. *MasterAccountApi* | [**corporateSubAccountIdApplicationsTogglePut**](docs/Api/MasterAccountApi.md#corporatesubaccountidapplicationstoggleput) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s) *MasterAccountApi* | [**corporateSubAccountIdDelete**](docs/Api/MasterAccountApi.md#corporatesubaccountiddelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account *MasterAccountApi* | [**corporateSubAccountIdGet**](docs/Api/MasterAccountApi.md#corporatesubaccountidget) | **GET** /corporate/subAccount/{id} | Get sub-account details *MasterAccountApi* | [**corporateSubAccountIdPlanPut**](docs/Api/MasterAccountApi.md#corporatesubaccountidplanput) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan *MasterAccountApi* | [**corporateSubAccountKeyPost**](docs/Api/MasterAccountApi.md#corporatesubaccountkeypost) | **POST** /corporate/subAccount/key | Create an API key for a sub-account *MasterAccountApi* | [**corporateSubAccountPost**](docs/Api/MasterAccountApi.md#corporatesubaccountpost) | **POST** /corporate/subAccount | Create a new sub-account under a master account. *MasterAccountApi* | [**corporateSubAccountSsoTokenPost**](docs/Api/MasterAccountApi.md#corporatesubaccountssotokenpost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo *MasterAccountApi* | [**getAccountActivity**](docs/Api/MasterAccountApi.md#getaccountactivity) | **GET** /organization/activities | Get user activity logs *NotesApi* | [**crmNotesGet**](docs/Api/NotesApi.md#crmnotesget) | **GET** /crm/notes | Get all notes *NotesApi* | [**crmNotesIdDelete**](docs/Api/NotesApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note *NotesApi* | [**crmNotesIdGet**](docs/Api/NotesApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note *NotesApi* | [**crmNotesIdPatch**](docs/Api/NotesApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note *NotesApi* | [**crmNotesPost**](docs/Api/NotesApi.md#crmnotespost) | **POST** /crm/notes | Create a note *ProcessApi* | [**getProcess**](docs/Api/ProcessApi.md#getprocess) | **GET** /processes/{processId} | Return the informations for a process *ProcessApi* | [**getProcesses**](docs/Api/ProcessApi.md#getprocesses) | **GET** /processes | Return all the processes for your account *ResellerApi* | [**addCredits**](docs/Api/ResellerApi.md#addcredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account *ResellerApi* | [**associateIpToChild**](docs/Api/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child *ResellerApi* | [**createChildDomain**](docs/Api/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account *ResellerApi* | [**createResellerChild**](docs/Api/ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child *ResellerApi* | [**deleteChildDomain**](docs/Api/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed *ResellerApi* | [**deleteResellerChild**](docs/Api/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied *ResellerApi* | [**dissociateIpFromChild**](docs/Api/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child *ResellerApi* | [**getChildAccountCreationStatus**](docs/Api/ResellerApi.md#getchildaccountcreationstatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied *ResellerApi* | [**getChildDomains**](docs/Api/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account *ResellerApi* | [**getChildInfo**](docs/Api/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details *ResellerApi* | [**getResellerChilds**](docs/Api/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Get the list of all children accounts *ResellerApi* | [**getSsoToken**](docs/Api/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO) *ResellerApi* | [**removeCredits**](docs/Api/ResellerApi.md#removecredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account *ResellerApi* | [**updateChildAccountStatus**](docs/Api/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied *ResellerApi* | [**updateChildDomain**](docs/Api/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed *ResellerApi* | [**updateResellerChild**](docs/Api/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied *SMSCampaignsApi* | [**createSmsCampaign**](docs/Api/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign *SMSCampaignsApi* | [**deleteSmsCampaign**](docs/Api/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign *SMSCampaignsApi* | [**getSmsCampaign**](docs/Api/SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign *SMSCampaignsApi* | [**getSmsCampaigns**](docs/Api/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns *SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/Api/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients *SMSCampaignsApi* | [**sendSmsCampaignNow**](docs/Api/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately *SMSCampaignsApi* | [**sendSmsReport**](docs/Api/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report *SMSCampaignsApi* | [**sendTestSms**](docs/Api/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign *SMSCampaignsApi* | [**updateSmsCampaign**](docs/Api/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign *SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status *SendersApi* | [**createSender**](docs/Api/SendersApi.md#createsender) | **POST** /senders | Create a new sender *SendersApi* | [**deleteSender**](docs/Api/SendersApi.md#deletesender) | **DELETE** /senders/{senderId} | Delete a sender *SendersApi* | [**getIps**](docs/Api/SendersApi.md#getips) | **GET** /senders/ips | Get all the dedicated IPs for your account *SendersApi* | [**getIpsFromSender**](docs/Api/SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender *SendersApi* | [**getSenders**](docs/Api/SendersApi.md#getsenders) | **GET** /senders | Get the list of all your senders *SendersApi* | [**updateSender**](docs/Api/SendersApi.md#updatesender) | **PUT** /senders/{senderId} | Update a sender *SendersApi* | [**validateSenderByOTP**](docs/Api/SendersApi.md#validatesenderbyotp) | **PUT** /senders/{senderId}/validate | Update a sender *TasksApi* | [**crmTasksGet**](docs/Api/TasksApi.md#crmtasksget) | **GET** /crm/tasks | Get all tasks *TasksApi* | [**crmTasksIdDelete**](docs/Api/TasksApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task *TasksApi* | [**crmTasksIdGet**](docs/Api/TasksApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task *TasksApi* | [**crmTasksIdPatch**](docs/Api/TasksApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task *TasksApi* | [**crmTasksPost**](docs/Api/TasksApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task *TasksApi* | [**crmTasktypesGet**](docs/Api/TasksApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types *TransactionalEmailsApi* | [**blockNewDomain**](docs/Api/TransactionalEmailsApi.md#blocknewdomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains *TransactionalEmailsApi* | [**createSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template *TransactionalEmailsApi* | [**deleteBlockedDomain**](docs/Api/TransactionalEmailsApi.md#deleteblockeddomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains *TransactionalEmailsApi* | [**deleteHardbounces**](docs/Api/TransactionalEmailsApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces *TransactionalEmailsApi* | [**deleteScheduledEmailById**](docs/Api/TransactionalEmailsApi.md#deletescheduledemailbyid) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId *TransactionalEmailsApi* | [**deleteSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template *TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/Api/TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time *TransactionalEmailsApi* | [**getBlockedDomains**](docs/Api/TransactionalEmailsApi.md#getblockeddomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains *TransactionalEmailsApi* | [**getEmailEventReport**](docs/Api/TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) *TransactionalEmailsApi* | [**getScheduledEmailByBatchId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbybatchid) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId *TransactionalEmailsApi* | [**getScheduledEmailByMessageId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbymessageid) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId *TransactionalEmailsApi* | [**getSmtpReport**](docs/Api/TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day *TransactionalEmailsApi* | [**getSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information *TransactionalEmailsApi* | [**getSmtpTemplates**](docs/Api/TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates *TransactionalEmailsApi* | [**getTransacBlockedContacts**](docs/Api/TransactionalEmailsApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts *TransactionalEmailsApi* | [**getTransacEmailContent**](docs/Api/TransactionalEmailsApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email *TransactionalEmailsApi* | [**getTransacEmailsList**](docs/Api/TransactionalEmailsApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters *TransactionalEmailsApi* | [**sendTestTemplate**](docs/Api/TransactionalEmailsApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list *TransactionalEmailsApi* | [**sendTransacEmail**](docs/Api/TransactionalEmailsApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email *TransactionalEmailsApi* | [**smtpBlockedContactsEmailDelete**](docs/Api/TransactionalEmailsApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact *TransactionalEmailsApi* | [**smtpLogMessageIdDelete**](docs/Api/TransactionalEmailsApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log *TransactionalEmailsApi* | [**updateSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template *TransactionalSMSApi* | [**getSmsEvents**](docs/Api/TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) *TransactionalSMSApi* | [**getTransacAggregatedSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacaggregatedsmsreport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time *TransactionalSMSApi* | [**getTransacSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacsmsreport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day *TransactionalSMSApi* | [**sendTransacSms**](docs/Api/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number *TransactionalWhatsAppApi* | [**getWhatsappEventReport**](docs/Api/TransactionalWhatsAppApi.md#getwhatsappeventreport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events) *TransactionalWhatsAppApi* | [**sendWhatsappMessage**](docs/Api/TransactionalWhatsAppApi.md#sendwhatsappmessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message *UserApi* | [**getInvitedUsersList**](docs/Api/UserApi.md#getinviteduserslist) | **GET** /organization/invited/users | Get the list of all your users *UserApi* | [**getUserPermission**](docs/Api/UserApi.md#getuserpermission) | **GET** /organization/user/{email}/permissions | Check user permission *WebhooksApi* | [**createWebhook**](docs/Api/WebhooksApi.md#createwebhook) | **POST** /webhooks | Create a webhook *WebhooksApi* | [**deleteWebhook**](docs/Api/WebhooksApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook *WebhooksApi* | [**exportWebhooksHistory**](docs/Api/WebhooksApi.md#exportwebhookshistory) | **POST** /webhooks/export | Export all transactional events *WebhooksApi* | [**getWebhook**](docs/Api/WebhooksApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook details *WebhooksApi* | [**getWebhooks**](docs/Api/WebhooksApi.md#getwebhooks) | **GET** /webhooks | Get all webhooks *WebhooksApi* | [**updateWebhook**](docs/Api/WebhooksApi.md#updatewebhook) | **PUT** /webhooks/{webhookId} | Update a webhook *WhatsAppCampaignsApi* | [**createWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#createwhatsappcampaign) | **POST** /whatsappCampaigns | Create and Send a WhatsApp campaign *WhatsAppCampaignsApi* | [**createWhatsAppTemplate**](docs/Api/WhatsAppCampaignsApi.md#createwhatsapptemplate) | **POST** /whatsppCampaigns/template | Create a WhatsApp template *WhatsAppCampaignsApi* | [**deleteWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#deletewhatsappcampaign) | **DELETE** /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign *WhatsAppCampaignsApi* | [**getWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappcampaign) | **GET** /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign *WhatsAppCampaignsApi* | [**getWhatsAppCampaigns**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappcampaigns) | **GET** /whatsappCampaigns | Return all your created WhatsApp campaigns *WhatsAppCampaignsApi* | [**getWhatsAppConfig**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappconfig) | **GET** /whatsappCampaigns/config | Get your WhatsApp API account information *WhatsAppCampaignsApi* | [**getWhatsAppTemplates**](docs/Api/WhatsAppCampaignsApi.md#getwhatsapptemplates) | **GET** /whatsappCampaigns/template-list | Return all your created WhatsApp templates *WhatsAppCampaignsApi* | [**sendWhatsAppTemplateApproval**](docs/Api/WhatsAppCampaignsApi.md#sendwhatsapptemplateapproval) | **POST** /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval *WhatsAppCampaignsApi* | [**updateWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#updatewhatsappcampaign) | **PUT** /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign ## Documentation For Models - [AbTestCampaignResult](docs/Model/AbTestCampaignResult.md) - [AbTestCampaignResultClickedLinks](docs/Model/AbTestCampaignResultClickedLinks.md) - [AbTestCampaignResultStatistics](docs/Model/AbTestCampaignResultStatistics.md) - [AbTestVersionClicks](docs/Model/AbTestVersionClicks.md) - [AbTestVersionClicksInner](docs/Model/AbTestVersionClicksInner.md) - [AbTestVersionStats](docs/Model/AbTestVersionStats.md) - [AddChildDomain](docs/Model/AddChildDomain.md) - [AddContactToList](docs/Model/AddContactToList.md) - [AddCredits](docs/Model/AddCredits.md) - [AuthenticateDomainModel](docs/Model/AuthenticateDomainModel.md) - [BlockDomain](docs/Model/BlockDomain.md) - [Body](docs/Model/Body.md) - [Body1](docs/Model/Body1.md) - [Body10](docs/Model/Body10.md) - [Body11](docs/Model/Body11.md) - [Body12](docs/Model/Body12.md) - [Body2](docs/Model/Body2.md) - [Body3](docs/Model/Body3.md) - [Body4](docs/Model/Body4.md) - [Body5](docs/Model/Body5.md) - [Body6](docs/Model/Body6.md) - [Body7](docs/Model/Body7.md) - [Body8](docs/Model/Body8.md) - [Body9](docs/Model/Body9.md) - [BodyVariablesItems](docs/Model/BodyVariablesItems.md) - [CompaniesList](docs/Model/CompaniesList.md) - [Company](docs/Model/Company.md) - [CompanyAttributes](docs/Model/CompanyAttributes.md) - [CompanyAttributesInner](docs/Model/CompanyAttributesInner.md) - [ComponentItems](docs/Model/ComponentItems.md) - [ConversationsMessage](docs/Model/ConversationsMessage.md) - [ConversationsMessageFile](docs/Model/ConversationsMessageFile.md) - [ConversationsMessageFileImageInfo](docs/Model/ConversationsMessageFileImageInfo.md) - [CreateApiKeyRequest](docs/Model/CreateApiKeyRequest.md) - [CreateApiKeyResponse](docs/Model/CreateApiKeyResponse.md) - [CreateAttribute](docs/Model/CreateAttribute.md) - [CreateAttributeEnumeration](docs/Model/CreateAttributeEnumeration.md) - [CreateCategoryModel](docs/Model/CreateCategoryModel.md) - [CreateChild](docs/Model/CreateChild.md) - [CreateContact](docs/Model/CreateContact.md) - [CreateCouponCollection](docs/Model/CreateCouponCollection.md) - [CreateCoupons](docs/Model/CreateCoupons.md) - [CreateDoiContact](docs/Model/CreateDoiContact.md) - [CreateDomain](docs/Model/CreateDomain.md) - [CreateDomainModel](docs/Model/CreateDomainModel.md) - [CreateDomainModelDnsRecords](docs/Model/CreateDomainModelDnsRecords.md) - [CreateDomainModelDnsRecordsDkimRecord](docs/Model/CreateDomainModelDnsRecordsDkimRecord.md) - [CreateEmailCampaign](docs/Model/CreateEmailCampaign.md) - [CreateEmailCampaignRecipients](docs/Model/CreateEmailCampaignRecipients.md) - [CreateEmailCampaignSender](docs/Model/CreateEmailCampaignSender.md) - [CreateExternalFeed](docs/Model/CreateExternalFeed.md) - [CreateList](docs/Model/CreateList.md) - [CreateModel](docs/Model/CreateModel.md) - [CreateProductModel](docs/Model/CreateProductModel.md) - [CreateReseller](docs/Model/CreateReseller.md) - [CreateSender](docs/Model/CreateSender.md) - [CreateSenderIps](docs/Model/CreateSenderIps.md) - [CreateSenderModel](docs/Model/CreateSenderModel.md) - [CreateSmsCampaign](docs/Model/CreateSmsCampaign.md) - [CreateSmsCampaignRecipients](docs/Model/CreateSmsCampaignRecipients.md) - [CreateSmtpEmail](docs/Model/CreateSmtpEmail.md) - [CreateSmtpTemplate](docs/Model/CreateSmtpTemplate.md) - [CreateSmtpTemplateSender](docs/Model/CreateSmtpTemplateSender.md) - [CreateSubAccount](docs/Model/CreateSubAccount.md) - [CreateSubAccountResponse](docs/Model/CreateSubAccountResponse.md) - [CreateUpdateBatchCategory](docs/Model/CreateUpdateBatchCategory.md) - [CreateUpdateBatchCategoryModel](docs/Model/CreateUpdateBatchCategoryModel.md) - [CreateUpdateBatchProducts](docs/Model/CreateUpdateBatchProducts.md) - [CreateUpdateBatchProductsModel](docs/Model/CreateUpdateBatchProductsModel.md) - [CreateUpdateCategories](docs/Model/CreateUpdateCategories.md) - [CreateUpdateCategory](docs/Model/CreateUpdateCategory.md) - [CreateUpdateContactModel](docs/Model/CreateUpdateContactModel.md) - [CreateUpdateFolder](docs/Model/CreateUpdateFolder.md) - [CreateUpdateProduct](docs/Model/CreateUpdateProduct.md) - [CreateUpdateProducts](docs/Model/CreateUpdateProducts.md) - [CreateWebhook](docs/Model/CreateWebhook.md) - [CreateWhatsAppCampaign](docs/Model/CreateWhatsAppCampaign.md) - [CreateWhatsAppCampaignRecipients](docs/Model/CreateWhatsAppCampaignRecipients.md) - [CreateWhatsAppTemplate](docs/Model/CreateWhatsAppTemplate.md) - [CreatedBatchId](docs/Model/CreatedBatchId.md) - [CreatedProcessId](docs/Model/CreatedProcessId.md) - [Deal](docs/Model/Deal.md) - [DealAttributes](docs/Model/DealAttributes.md) - [DealAttributesInner](docs/Model/DealAttributesInner.md) - [DealsList](docs/Model/DealsList.md) - [DeleteHardbounces](docs/Model/DeleteHardbounces.md) - [EmailExportRecipients](docs/Model/EmailExportRecipients.md) - [ErrorModel](docs/Model/ErrorModel.md) - [ExportWebhooksHistory](docs/Model/ExportWebhooksHistory.md) - [FileData](docs/Model/FileData.md) - [FileDownloadableLink](docs/Model/FileDownloadableLink.md) - [FileList](docs/Model/FileList.md) - [GetAccount](docs/Model/GetAccount.md) - [GetAccountActivity](docs/Model/GetAccountActivity.md) - [GetAccountActivityLogs](docs/Model/GetAccountActivityLogs.md) - [GetAccountMarketingAutomation](docs/Model/GetAccountMarketingAutomation.md) - [GetAccountPlan](docs/Model/GetAccountPlan.md) - [GetAccountRelay](docs/Model/GetAccountRelay.md) - [GetAccountRelayData](docs/Model/GetAccountRelayData.md) - [GetAggregatedReport](docs/Model/GetAggregatedReport.md) - [GetAllExternalFeeds](docs/Model/GetAllExternalFeeds.md) - [GetAllExternalFeedsFeeds](docs/Model/GetAllExternalFeedsFeeds.md) - [GetAttributes](docs/Model/GetAttributes.md) - [GetAttributesAttributes](docs/Model/GetAttributesAttributes.md) - [GetAttributesEnumeration](docs/Model/GetAttributesEnumeration.md) - [GetBlockedDomains](docs/Model/GetBlockedDomains.md) - [GetCampaignOverview](docs/Model/GetCampaignOverview.md) - [GetCampaignRecipients](docs/Model/GetCampaignRecipients.md) - [GetCampaignStats](docs/Model/GetCampaignStats.md) - [GetCategories](docs/Model/GetCategories.md) - [GetCategoryDetails](docs/Model/GetCategoryDetails.md) - [GetChildAccountCreationStatus](docs/Model/GetChildAccountCreationStatus.md) - [GetChildDomain](docs/Model/GetChildDomain.md) - [GetChildDomains](docs/Model/GetChildDomains.md) - [GetChildInfo](docs/Model/GetChildInfo.md) - [GetChildInfoApiKeys](docs/Model/GetChildInfoApiKeys.md) - [GetChildInfoApiKeysV2](docs/Model/GetChildInfoApiKeysV2.md) - [GetChildInfoApiKeysV3](docs/Model/GetChildInfoApiKeysV3.md) - [GetChildInfoCredits](docs/Model/GetChildInfoCredits.md) - [GetChildInfoStatistics](docs/Model/GetChildInfoStatistics.md) - [GetChildrenList](docs/Model/GetChildrenList.md) - [GetClient](docs/Model/GetClient.md) - [GetContactCampaignStats](docs/Model/GetContactCampaignStats.md) - [GetContactCampaignStatsClicked](docs/Model/GetContactCampaignStatsClicked.md) - [GetContactCampaignStatsOpened](docs/Model/GetContactCampaignStatsOpened.md) - [GetContactCampaignStatsTransacAttributes](docs/Model/GetContactCampaignStatsTransacAttributes.md) - [GetContactCampaignStatsUnsubscriptions](docs/Model/GetContactCampaignStatsUnsubscriptions.md) - [GetContactDetails](docs/Model/GetContactDetails.md) - [GetContacts](docs/Model/GetContacts.md) - [GetCouponCollection](docs/Model/GetCouponCollection.md) - [GetDeviceBrowserStats](docs/Model/GetDeviceBrowserStats.md) - [GetDomainConfigurationModel](docs/Model/GetDomainConfigurationModel.md) - [GetDomainsList](docs/Model/GetDomainsList.md) - [GetDomainsListDomains](docs/Model/GetDomainsListDomains.md) - [GetEmailCampaign](docs/Model/GetEmailCampaign.md) - [GetEmailCampaigns](docs/Model/GetEmailCampaigns.md) - [GetEmailEventReport](docs/Model/GetEmailEventReport.md) - [GetEmailEventReportEvents](docs/Model/GetEmailEventReportEvents.md) - [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md) - [GetExtendedCampaignOverviewSender](docs/Model/GetExtendedCampaignOverviewSender.md) - [GetExtendedCampaignStats](docs/Model/GetExtendedCampaignStats.md) - [GetExtendedCampaignStatsGlobalStats](docs/Model/GetExtendedCampaignStatsGlobalStats.md) - [GetExtendedClient](docs/Model/GetExtendedClient.md) - [GetExtendedClientAddress](docs/Model/GetExtendedClientAddress.md) - [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md) - [GetExtendedContactDetailsStatistics](docs/Model/GetExtendedContactDetailsStatistics.md) - [GetExtendedContactDetailsStatisticsClicked](docs/Model/GetExtendedContactDetailsStatisticsClicked.md) - [GetExtendedContactDetailsStatisticsDelivered](docs/Model/GetExtendedContactDetailsStatisticsDelivered.md) - [GetExtendedContactDetailsStatisticsLinks](docs/Model/GetExtendedContactDetailsStatisticsLinks.md) - [GetExtendedContactDetailsStatisticsMessagesSent](docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md) - [GetExtendedContactDetailsStatisticsOpened](docs/Model/GetExtendedContactDetailsStatisticsOpened.md) - [GetExtendedContactDetailsStatisticsUnsubscriptions](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md) - [GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) - [GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) - [GetExtendedList](docs/Model/GetExtendedList.md) - [GetExtendedListCampaignStats](docs/Model/GetExtendedListCampaignStats.md) - [GetExternalFeedByUUID](docs/Model/GetExternalFeedByUUID.md) - [GetExternalFeedByUUIDHeaders](docs/Model/GetExternalFeedByUUIDHeaders.md) - [GetFolder](docs/Model/GetFolder.md) - [GetFolderLists](docs/Model/GetFolderLists.md) - [GetFolders](docs/Model/GetFolders.md) - [GetInboundEmailEvents](docs/Model/GetInboundEmailEvents.md) - [GetInboundEmailEventsByUuid](docs/Model/GetInboundEmailEventsByUuid.md) - [GetInboundEmailEventsByUuidAttachments](docs/Model/GetInboundEmailEventsByUuidAttachments.md) - [GetInboundEmailEventsByUuidLogs](docs/Model/GetInboundEmailEventsByUuidLogs.md) - [GetInboundEmailEventsEvents](docs/Model/GetInboundEmailEventsEvents.md) - [GetInvitedUsersList](docs/Model/GetInvitedUsersList.md) - [GetInvitedUsersListFeatureAccess](docs/Model/GetInvitedUsersListFeatureAccess.md) - [GetInvitedUsersListUsers](docs/Model/GetInvitedUsersListUsers.md) - [GetIp](docs/Model/GetIp.md) - [GetIpFromSender](docs/Model/GetIpFromSender.md) - [GetIps](docs/Model/GetIps.md) - [GetIpsFromSender](docs/Model/GetIpsFromSender.md) - [GetList](docs/Model/GetList.md) - [GetLists](docs/Model/GetLists.md) - [GetProcess](docs/Model/GetProcess.md) - [GetProcesses](docs/Model/GetProcesses.md) - [GetProductDetails](docs/Model/GetProductDetails.md) - [GetProducts](docs/Model/GetProducts.md) - [GetReports](docs/Model/GetReports.md) - [GetReportsReports](docs/Model/GetReportsReports.md) - [GetScheduledEmailByBatchId](docs/Model/GetScheduledEmailByBatchId.md) - [GetScheduledEmailByBatchIdBatches](docs/Model/GetScheduledEmailByBatchIdBatches.md) - [GetScheduledEmailByMessageId](docs/Model/GetScheduledEmailByMessageId.md) - [GetSegments](docs/Model/GetSegments.md) - [GetSegmentsSegments](docs/Model/GetSegmentsSegments.md) - [GetSendersList](docs/Model/GetSendersList.md) - [GetSendersListIps](docs/Model/GetSendersListIps.md) - [GetSendersListSenders](docs/Model/GetSendersListSenders.md) - [GetSharedTemplateUrl](docs/Model/GetSharedTemplateUrl.md) - [GetSmsCampaign](docs/Model/GetSmsCampaign.md) - [GetSmsCampaignOverview](docs/Model/GetSmsCampaignOverview.md) - [GetSmsCampaignRecipients](docs/Model/GetSmsCampaignRecipients.md) - [GetSmsCampaignStats](docs/Model/GetSmsCampaignStats.md) - [GetSmsCampaigns](docs/Model/GetSmsCampaigns.md) - [GetSmsEventReport](docs/Model/GetSmsEventReport.md) - [GetSmsEventReportEvents](docs/Model/GetSmsEventReportEvents.md) - [GetSmtpTemplateOverview](docs/Model/GetSmtpTemplateOverview.md) - [GetSmtpTemplateOverviewSender](docs/Model/GetSmtpTemplateOverviewSender.md) - [GetSmtpTemplates](docs/Model/GetSmtpTemplates.md) - [GetSsoToken](docs/Model/GetSsoToken.md) - [GetStatsByBrowser](docs/Model/GetStatsByBrowser.md) - [GetStatsByDevice](docs/Model/GetStatsByDevice.md) - [GetStatsByDomain](docs/Model/GetStatsByDomain.md) - [GetTransacAggregatedSmsReport](docs/Model/GetTransacAggregatedSmsReport.md) - [GetTransacBlockedContacts](docs/Model/GetTransacBlockedContacts.md) - [GetTransacBlockedContactsContacts](docs/Model/GetTransacBlockedContactsContacts.md) - [GetTransacBlockedContactsReason](docs/Model/GetTransacBlockedContactsReason.md) - [GetTransacEmailContent](docs/Model/GetTransacEmailContent.md) - [GetTransacEmailContentEvents](docs/Model/GetTransacEmailContentEvents.md) - [GetTransacEmailsList](docs/Model/GetTransacEmailsList.md) - [GetTransacEmailsListTransactionalEmails](docs/Model/GetTransacEmailsListTransactionalEmails.md) - [GetTransacSmsReport](docs/Model/GetTransacSmsReport.md) - [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md) - [GetUserPermission](docs/Model/GetUserPermission.md) - [GetUserPermissionPrivileges](docs/Model/GetUserPermissionPrivileges.md) - [GetWATemplates](docs/Model/GetWATemplates.md) - [GetWATemplatesTemplates](docs/Model/GetWATemplatesTemplates.md) - [GetWebhook](docs/Model/GetWebhook.md) - [GetWebhooks](docs/Model/GetWebhooks.md) - [GetWhatsAppConfig](docs/Model/GetWhatsAppConfig.md) - [GetWhatsappCampaignOverview](docs/Model/GetWhatsappCampaignOverview.md) - [GetWhatsappCampaigns](docs/Model/GetWhatsappCampaigns.md) - [GetWhatsappCampaignsCampaigns](docs/Model/GetWhatsappCampaignsCampaigns.md) - [GetWhatsappEventReport](docs/Model/GetWhatsappEventReport.md) - [GetWhatsappEventReportEvents](docs/Model/GetWhatsappEventReportEvents.md) - [InlineResponse200](docs/Model/InlineResponse200.md) - [InlineResponse2001](docs/Model/InlineResponse2001.md) - [InlineResponse201](docs/Model/InlineResponse201.md) - [InlineResponse2011](docs/Model/InlineResponse2011.md) - [InlineResponse2012](docs/Model/InlineResponse2012.md) - [InlineResponse2013](docs/Model/InlineResponse2013.md) - [InlineResponse2014](docs/Model/InlineResponse2014.md) - [ManageIp](docs/Model/ManageIp.md) - [MasterDetailsResponse](docs/Model/MasterDetailsResponse.md) - [MasterDetailsResponseBillingInfo](docs/Model/MasterDetailsResponseBillingInfo.md) - [MasterDetailsResponseBillingInfoAddress](docs/Model/MasterDetailsResponseBillingInfoAddress.md) - [MasterDetailsResponseBillingInfoName](docs/Model/MasterDetailsResponseBillingInfoName.md) - [MasterDetailsResponsePlanInfo](docs/Model/MasterDetailsResponsePlanInfo.md) - [MasterDetailsResponsePlanInfoFeatures](docs/Model/MasterDetailsResponsePlanInfoFeatures.md) - [Note](docs/Model/Note.md) - [NoteData](docs/Model/NoteData.md) - [NoteId](docs/Model/NoteId.md) - [NoteList](docs/Model/NoteList.md) - [Order](docs/Model/Order.md) - [OrderBatch](docs/Model/OrderBatch.md) - [OrderBilling](docs/Model/OrderBilling.md) - [OrderProducts](docs/Model/OrderProducts.md) - [Otp](docs/Model/Otp.md) - [Pipeline](docs/Model/Pipeline.md) - [PipelineStage](docs/Model/PipelineStage.md) - [Pipelines](docs/Model/Pipelines.md) - [PostContactInfo](docs/Model/PostContactInfo.md) - [PostContactInfoContacts](docs/Model/PostContactInfoContacts.md) - [PostSendFailed](docs/Model/PostSendFailed.md) - [PostSendSmsTestFailed](docs/Model/PostSendSmsTestFailed.md) - [RemainingCreditModel](docs/Model/RemainingCreditModel.md) - [RemainingCreditModelChild](docs/Model/RemainingCreditModelChild.md) - [RemainingCreditModelReseller](docs/Model/RemainingCreditModelReseller.md) - [RemoveContactFromList](docs/Model/RemoveContactFromList.md) - [RemoveCredits](docs/Model/RemoveCredits.md) - [RequestContactExport](docs/Model/RequestContactExport.md) - [RequestContactExportCustomContactFilter](docs/Model/RequestContactExportCustomContactFilter.md) - [RequestContactImport](docs/Model/RequestContactImport.md) - [RequestContactImportJsonBody](docs/Model/RequestContactImportJsonBody.md) - [RequestContactImportNewList](docs/Model/RequestContactImportNewList.md) - [RequestSmsRecipientExport](docs/Model/RequestSmsRecipientExport.md) - [ScheduleSmtpEmail](docs/Model/ScheduleSmtpEmail.md) - [SendReport](docs/Model/SendReport.md) - [SendReportEmail](docs/Model/SendReportEmail.md) - [SendSms](docs/Model/SendSms.md) - [SendSmtpEmail](docs/Model/SendSmtpEmail.md) - [SendSmtpEmailAttachment](docs/Model/SendSmtpEmailAttachment.md) - [SendSmtpEmailBcc](docs/Model/SendSmtpEmailBcc.md) - [SendSmtpEmailCc](docs/Model/SendSmtpEmailCc.md) - [SendSmtpEmailMessageVersions](docs/Model/SendSmtpEmailMessageVersions.md) - [SendSmtpEmailReplyTo](docs/Model/SendSmtpEmailReplyTo.md) - [SendSmtpEmailReplyTo1](docs/Model/SendSmtpEmailReplyTo1.md) - [SendSmtpEmailSender](docs/Model/SendSmtpEmailSender.md) - [SendSmtpEmailTo](docs/Model/SendSmtpEmailTo.md) - [SendSmtpEmailTo1](docs/Model/SendSmtpEmailTo1.md) - [SendTestEmail](docs/Model/SendTestEmail.md) - [SendTestSms](docs/Model/SendTestSms.md) - [SendTransacSms](docs/Model/SendTransacSms.md) - [SendWhatsappMessage](docs/Model/SendWhatsappMessage.md) - [SsoTokenRequest](docs/Model/SsoTokenRequest.md) - [SubAccountAppsToggleRequest](docs/Model/SubAccountAppsToggleRequest.md) - [SubAccountDetailsResponse](docs/Model/SubAccountDetailsResponse.md) - [SubAccountDetailsResponsePlanInfo](docs/Model/SubAccountDetailsResponsePlanInfo.md) - [SubAccountDetailsResponsePlanInfoCredits](docs/Model/SubAccountDetailsResponsePlanInfoCredits.md) - [SubAccountDetailsResponsePlanInfoCreditsEmails](docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md) - [SubAccountDetailsResponsePlanInfoFeatures](docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md) - [SubAccountDetailsResponsePlanInfoFeaturesInbox](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md) - [SubAccountDetailsResponsePlanInfoFeaturesLandingPage](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) - [SubAccountDetailsResponsePlanInfoFeaturesUsers](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md) - [SubAccountUpdatePlanRequest](docs/Model/SubAccountUpdatePlanRequest.md) - [SubAccountUpdatePlanRequestCredits](docs/Model/SubAccountUpdatePlanRequestCredits.md) - [SubAccountUpdatePlanRequestFeatures](docs/Model/SubAccountUpdatePlanRequestFeatures.md) - [SubAccountsResponse](docs/Model/SubAccountsResponse.md) - [SubAccountsResponseSubAccounts](docs/Model/SubAccountsResponseSubAccounts.md) - [Task](docs/Model/Task.md) - [TaskList](docs/Model/TaskList.md) - [TaskReminder](docs/Model/TaskReminder.md) - [TaskTypes](docs/Model/TaskTypes.md) - [UpdateAttribute](docs/Model/UpdateAttribute.md) - [UpdateAttributeEnumeration](docs/Model/UpdateAttributeEnumeration.md) - [UpdateBatchContacts](docs/Model/UpdateBatchContacts.md) - [UpdateBatchContactsContacts](docs/Model/UpdateBatchContactsContacts.md) - [UpdateBatchContactsModel](docs/Model/UpdateBatchContactsModel.md) - [UpdateCampaignStatus](docs/Model/UpdateCampaignStatus.md) - [UpdateChild](docs/Model/UpdateChild.md) - [UpdateChildAccountStatus](docs/Model/UpdateChildAccountStatus.md) - [UpdateChildDomain](docs/Model/UpdateChildDomain.md) - [UpdateContact](docs/Model/UpdateContact.md) - [UpdateCouponCollection](docs/Model/UpdateCouponCollection.md) - [UpdateEmailCampaign](docs/Model/UpdateEmailCampaign.md) - [UpdateEmailCampaignRecipients](docs/Model/UpdateEmailCampaignRecipients.md) - [UpdateEmailCampaignSender](docs/Model/UpdateEmailCampaignSender.md) - [UpdateExternalFeed](docs/Model/UpdateExternalFeed.md) - [UpdateList](docs/Model/UpdateList.md) - [UpdateSender](docs/Model/UpdateSender.md) - [UpdateSmsCampaign](docs/Model/UpdateSmsCampaign.md) - [UpdateSmtpTemplate](docs/Model/UpdateSmtpTemplate.md) - [UpdateSmtpTemplateSender](docs/Model/UpdateSmtpTemplateSender.md) - [UpdateWebhook](docs/Model/UpdateWebhook.md) - [UpdateWhatsAppCampaign](docs/Model/UpdateWhatsAppCampaign.md) - [UploadImageModel](docs/Model/UploadImageModel.md) - [UploadImageToGallery](docs/Model/UploadImageToGallery.md) - [GetChildInfo](docs/Model/GetChildInfo.md) - [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md) - [GetExtendedClient](docs/Model/GetExtendedClient.md) - [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md) - [GetExtendedList](docs/Model/GetExtendedList.md) - [GetSmsCampaign](docs/Model/GetSmsCampaign.md) - [GetAccount](docs/Model/GetAccount.md) - [GetEmailCampaign](docs/Model/GetEmailCampaign.md) - [VariablesItems](docs/Model/VariablesItems.md) - [WhatsappCampStats](docs/Model/WhatsappCampStats.md) - [WhatsappCampTemplate](docs/Model/WhatsappCampTemplate.md) ## Documentation For Authorization ## api-key The API key should be passed in the request headers as `api-key` for authentication. - **Type**: API key - **API key parameter name**: api-key - **Location**: HTTP header ## partner-key The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional). - **Type**: API key - **API key parameter name**: partner-key - **Location**: HTTP header If you find a bug, please post the issue on [Github](https://github.com/getbrevo/brevo-php/issues). As always, if you need additional assistance, drop us a note [here](https://account.brevo.com/support).
| ver. 1.4 |
Github
|
.
| PHP 8.1.29 | Генерация страницы: 0 |
proxy
|
phpinfo
|
Настройка