Supported functions in SDKs

This is the list of all possible API operations accesible through our official API Clients.

ClassMethodHTTP requestDescription
AccountApigetAccountGET /accountGet your account information, plan and credits details
AttributesApicreateAttributePOST /contacts/attributes/{attributeCategory}/{attributeName}Create contact attribute
AttributesApideleteAttributeDELETE /contacts/attributes/{attributeCategory}/{attributeName}Delete an attribute
AttributesApigetAttributesGET /contacts/attributesList all attributes
AttributesApiupdateAttributePUT /contacts/attributes/{attributeCategory}/{attributeName}Update contact attribute
ContactsApiaddContactToListPOST /contacts/lists/{listId}/contacts/addAdd existing contacts to a list
ContactsApicreateAttributePOST /contacts/attributes/{attributeCategory}/{attributeName}Create contact attribute
ContactsApicreateContactPOST /contactsCreate a contact
ContactsApicreateDoiContactPOST /contacts/doubleOptinConfirmationCreate a contact to trigger the DOI workflow from a Landing Page form
ContactsApicreateFolderPOST /contacts/foldersCreate a folder
ContactsApicreateListPOST /contacts/listsCreate a list
ContactsApideleteAttributeDELETE /contacts/attributes/{attributeCategory}/{attributeName}Delete an attribute
ContactsApideleteContactDELETE /contacts/{email}Delete a contact
ContactsApideleteFolderDELETE /contacts/folders/{folderId}Delete a folder (and all its lists)
ContactsApideleteListDELETE /contacts/lists/{listId}Delete a list
ContactsApigetAttributesGET /contacts/attributesList all attributes
ContactsApigetContactInfoGET /contacts/{email}Get a contact's details
ContactsApigetContactStatsGET /contacts/{email}/campaignStatsGet email campaigns' statistics for a contact
ContactsApigetContactsGET /contactsGet all the contacts
ContactsApigetContactsFromListGET /contacts/lists/{listId}/contactsGet contacts in a list
ContactsApigetFolderGET /contacts/folders/{folderId}Returns a folder's details
ContactsApigetFolderListsGET /contacts/folders/{folderId}/listsGet lists in a folder
ContactsApigetFoldersGET /contacts/foldersGet all folders
ContactsApigetListGET /contacts/lists/{listId}Get a list's details
ContactsApigetListsGET /contacts/listsGet all the lists
ContactsApiimportContactsPOST /contacts/importImport contacts
ContactsApiremoveContactFromListPOST /contacts/lists/{listId}/contacts/removeDelete a contact from a list
ContactsApirequestContactExportPOST /contacts/exportExport contacts
ContactsApiupdateAttributePUT /contacts/attributes/{attributeCategory}/{attributeName}Update contact attribute
ContactsApiupdateContactPUT /contacts/{email}Update a contact
ContactsApiupdateFolderPUT /contacts/folders/{folderId}Update a folder
ContactsApiupdateListPUT /contacts/lists/{listId}Update a list
EmailCampaignsApicreateEmailCampaignPOST /emailCampaignsCreate an email campaign
EmailCampaignsApideleteEmailCampaignDELETE /emailCampaigns/{campaignId}Delete an email campaign
EmailCampaignsApiemailExportRecipientsPOST /emailCampaigns/{campaignId}/exportRecipientsExport the recipients of an email campaign
EmailCampaignsApigetAbTestCampaignResultGET /emailCampaigns/{campaignId}/abTestCampaignResultGet an A/B test email campaign results
EmailCampaignsApigetEmailCampaignGET /emailCampaigns/{campaignId}Get an email campaign report
EmailCampaignsApigetEmailCampaignsGET /emailCampaignsReturn all your created email campaigns
EmailCampaignsApigetSharedTemplateUrlGET /emailCampaigns/{campaignId}/sharedUrlGet a shared template url
EmailCampaignsApisendEmailCampaignNowPOST /emailCampaigns/{campaignId}/sendNowSend an email campaign immediately, based on campaignId
EmailCampaignsApisendReportPOST /emailCampaigns/{campaignId}/sendReportSend the report of a campaign
EmailCampaignsApisendTestEmailPOST /emailCampaigns/{campaignId}/sendTestSend an email campaign to your test list
EmailCampaignsApiupdateCampaignStatusPUT /emailCampaigns/{campaignId}/statusUpdate an email campaign status
EmailCampaignsApiupdateEmailCampaignPUT /emailCampaigns/{campaignId}Update an email campaign
EmailCampaignsApiuploadImageToGalleryPOST /emailCampaigns/imagesUpload an image to your account's image gallery
FoldersApicreateFolderPOST /contacts/foldersCreate a folder
FoldersApideleteFolderDELETE /contacts/folders/{folderId}Delete a folder (and all its lists)
FoldersApigetFolderGET /contacts/folders/{folderId}Returns a folder's details
FoldersApigetFolderListsGET /contacts/folders/{folderId}/listsGet lists in a folder
FoldersApigetFoldersGET /contacts/foldersGet all folders
FoldersApiupdateFolderPUT /contacts/folders/{folderId}Update a folder
ListsApiaddContactToListPOST /contacts/lists/{listId}/contacts/addAdd existing contacts to a list
ListsApicreateListPOST /contacts/listsCreate a list
ListsApideleteListDELETE /contacts/lists/{listId}Delete a list
ListsApigetContactsFromListGET /contacts/lists/{listId}/contactsGet contacts in a list
ListsApigetFolderListsGET /contacts/folders/{folderId}/listsGet lists in a folder
ListsApigetListGET /contacts/lists/{listId}Get a list's details
ListsApigetListsGET /contacts/listsGet all the lists
ListsApiremoveContactFromListPOST /contacts/lists/{listId}/contacts/removeDelete a contact from a list
ListsApiupdateListPUT /contacts/lists/{listId}Update a list
ProcessApigetProcessGET /processes/{processId}Return the informations for a process
ProcessApigetProcessesGET /processesReturn all the processes for your account
ResellerApiaddCreditsPOST /reseller/children/{childAuthKey}/credits/addAdd Email and/or SMS credits to a specific child account
ResellerApiassociateIpToChildPOST /reseller/children/{childAuthKey}/ips/associateAssociate a dedicated IP to the child
ResellerApicreateChildDomainPOST /reseller/children/{childAuthKey}/domainsCreate a domain for a child account
ResellerApicreateResellerChildPOST /reseller/childrenCreates a reseller child
ResellerApideleteChildDomainDELETE /reseller/children/{childAuthKey}/domains/{domainName}Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
ResellerApideleteResellerChildDELETE /reseller/children/{childAuthKey}Delete a single reseller child based on the childAuthKey supplied
ResellerApidissociateIpFromChildPOST /reseller/children/{childAuthKey}/ips/dissociateDissociate a dedicated IP to the child
ResellerApigetChildAccountCreationStatusGET /reseller/children/{childAuthKey}/accountCreationStatusGet the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
ResellerApigetChildDomainsGET /reseller/children/{childAuthKey}/domainsGet all sender domains for a specific child account
ResellerApigetChildInfoGET /reseller/children/{childAuthKey}Get a child account's details
ResellerApigetResellerChildsGET /reseller/childrenGet the list of all children accounts
ResellerApigetSsoTokenGET /reseller/children/{childAuthKey}/authGet session token to access Brevo (SSO)
ResellerApiremoveCreditsPOST /reseller/children/{childAuthKey}/credits/removeRemove Email and/or SMS credits from a specific child account
ResellerApiupdateChildAccountStatusPUT /reseller/children/{childAuthKey}/accountStatusUpdate info of reseller's child account status based on the childAuthKey supplied
ResellerApiupdateChildDomainPUT /reseller/children/{childAuthKey}/domains/{domainName}Update the sender domain of reseller's child based on the childAuthKey and domainName passed
ResellerApiupdateResellerChildPUT /reseller/children/{childAuthKey}Update info of reseller's child based on the childAuthKey supplied
SMSCampaignsApicreateSmsCampaignPOST /smsCampaignsCreates an SMS campaign
SMSCampaignsApideleteSmsCampaignDELETE /smsCampaigns/{campaignId}Delete an SMS campaign
SMSCampaignsApigetSmsCampaignGET /smsCampaigns/{campaignId}Get an SMS campaign
SMSCampaignsApigetSmsCampaignsGET /smsCampaignsReturns the information for all your created SMS campaigns
SMSCampaignsApirequestSmsRecipientExportPOST /smsCampaigns/{campaignId}/exportRecipientsExport an SMS campaign's recipients
SMSCampaignsApisendSmsCampaignNowPOST /smsCampaigns/{campaignId}/sendNowSend your SMS campaign immediately
SMSCampaignsApisendSmsReportPOST /smsCampaigns/{campaignId}/sendReportSend an SMS campaign's report
SMSCampaignsApisendTestSmsPOST /smsCampaigns/{campaignId}/sendTestSend a test SMS campaign
SMSCampaignsApiupdateSmsCampaignPUT /smsCampaigns/{campaignId}Update an SMS campaign
SMSCampaignsApiupdateSmsCampaignStatusPUT /smsCampaigns/{campaignId}/statusUpdate a campaign's status
SMTPApicreateSmtpTemplatePOST /smtp/templatesCreate an email template
SMTPApideleteHardbouncesPOST /smtp/deleteHardbouncesDelete hardbounces
SMTPApideleteSmtpTemplateDELETE /smtp/templates/{templateId}Delete an inactive email template
SMTPApigetAggregatedSmtpReportGET /smtp/statistics/aggregatedReportGet your transactional email activity aggregated over a period of time
SMTPApigetEmailEventReportGET /smtp/statistics/eventsGet all your transactional email activity (unaggregated events)
SMTPApigetSmtpReportGET /smtp/statistics/reportsGet your transactional email activity aggregated per day
SMTPApigetSmtpTemplateGET /smtp/templates/{templateId}Returns the template information
SMTPApigetSmtpTemplatesGET /smtp/templatesGet the list of email templates
SMTPApigetTransacBlockedContactsGET /smtp/blockedContactsGet the list of blocked or unsubscribed transactional contacts
SMTPApigetTransacEmailContentGET /smtp/emails/{uuid}Get the personalized content of a sent transactional email
SMTPApigetTransacEmailsListGET /smtp/emailsGet the list of transactional emails on the basis of allowed filters
SMTPApisendTemplatePOST /smtp/templates/{templateId}/sendSend a template
SMTPApisendTestTemplatePOST /smtp/templates/{templateId}/sendTestSend a template to your test list
SMTPApisendTransacEmailPOST /smtp/emailSend a transactional email
SMTPApismtpBlockedContactsEmailDeleteDELETE /smtp/blockedContacts/{email}Unblock or resubscribe a transactional contact
SMTPApismtpLogMessageIdDeleteDELETE /smtp/log/{messageId}Delete an SMTP transactional log
SMTPApiupdateSmtpTemplatePUT /smtp/templates/{templateId}Update an email template
SendersApicreateSenderPOST /sendersCreate a new sender
SendersApideleteSenderDELETE /senders/{senderId}Delete a sender
SendersApigetIpsGET /senders/ipsGet all the dedicated IPs for your account
SendersApigetIpsFromSenderGET /senders/{senderId}/ipsGet all the dedicated IPs for a sender
SendersApigetSendersGET /sendersGet the list of all your senders
SendersApiupdateSenderPUT /senders/{senderId}Update a sender
TransactionalSMSApigetSmsEventsGET /transactionalSMS/statistics/eventsGet all your SMS activity (unaggregated events)
TransactionalSMSApigetTransacAggregatedSmsReportGET /transactionalSMS/statistics/aggregatedReportGet your SMS activity aggregated over a period of time
TransactionalSMSApigetTransacSmsReportGET /transactionalSMS/statistics/reportsGet your SMS activity aggregated per day
TransactionalSMSApisendTransacSmsPOST /transactionalSMS/smsSend the SMS campaign to a mobile number
WebhooksApicreateWebhookPOST /webhooksCreate a webhook
WebhooksApideleteWebhookDELETE /webhooks/{webhookId}Delete a webhook
WebhooksApigetWebhookGET /webhooks/{webhookId}Get a webhook details
WebhooksApigetWebhooksGET /webhooksGet all webhooks
WebhooksApiupdateWebhookPUT /webhooks/{webhookId}Update a webhook