Netzo

🇺🇸 EN

🇪🇸 ES

🇺🇸 EN

🇪🇸 ES

Appearance

On this page
netzo/apis/brevo

Brevo ​

Brevo is a cloud-based property management software that helps property managers and landlords to manage their properties.

  • labels: property-management, real-estate, communication/email, customer-service
  • authentication: apiKey

Usage ​

ts
import { brevo } from 'https://deno.land/x/netzo/apis/brevo/mod.ts'

const { api } = brevo({
  apiKey: Deno.env.get('BREVO_API_KEY')
})
import { brevo } from 'https://deno.land/x/netzo/apis/brevo/mod.ts'

const { api } = brevo({
  apiKey: Deno.env.get('BREVO_API_KEY')
})

Configuration ​

The brevo factory function expects an object with the following, and returns an object with an HTTP client api.

ParamTypeDefaultDescription
apiKeystringDeno.env.get('BREVO_API_KEY')the api key to use for authentication

Refer to the API documentation to get the required information.

Examples ​

The following examples assume you have created an api client instance. Refer to the type definitions for all exported types to pass to the api client for typed responses.

Find contacts ​

Find all contacts with optional filtering and pagination.

ts
import type { Contacts, QueryContacts } from 'netzo/apis/brevo/types.ts'

const query: QueryContacts = {}
const result = await api.contacts.get<Contacts>(query)
const resultData = result.contacts
import type { Contacts, QueryContacts } from 'netzo/apis/brevo/types.ts'

const query: QueryContacts = {}
const result = await api.contacts.get<Contacts>(query)
const resultData = result.contacts

Get contact ​

Get a contact by its unique identifier, which can be id, email or SMS attribute value.

ts
import type { Contact, QueryContact } from 'netzo/apis/brevo/types.ts'

const query: QueryContact = {}
const resultData = await api.contacts[CONTACT_IDENTIFIER].get<Contact>(query)
import type { Contact, QueryContact } from 'netzo/apis/brevo/types.ts'

const query: QueryContact = {}
const resultData = await api.contacts[CONTACT_IDENTIFIER].get<Contact>(query)

Add contact ​

Add a new contact.

ts
import type { DataAddContact } from 'netzo/apis/brevo/types.ts'

const data: DataAddContact = { email: '[email protected]' }
const resultData = await api.contacts.post<{ id: number }>(data)
import type { DataAddContact } from 'netzo/apis/brevo/types.ts'

const data: DataAddContact = { email: '[email protected]' }
const resultData = await api.contacts.post<{ id: number }>(data)

Update contact ​

Update a contact by its unique identifier, which can be id, email or SMS attribute value.

ts
import type { DataUpdateContact } from 'netzo/apis/brevo/types.ts'

const data: DataUpdateContact = {
  attributes: {
    EMAIL: '[email protected]'
  }
}
await api.contacts[CONTACT_IDENTIFIER].put<void>(data)
import type { DataUpdateContact } from 'netzo/apis/brevo/types.ts'

const data: DataUpdateContact = {
  attributes: {
    EMAIL: '[email protected]'
  }
}
await api.contacts[CONTACT_IDENTIFIER].put<void>(data)

Find email campaigns ​

Find all email campaigns that match the query.

ts
import type { EmailCampaigns, QueryEmailCampaigns } from 'netzo/apis/brevo/types.ts'

const query: QueryEmailCampaigns = {}
const result = await api.emailCampaigns.get<EmailCampaigns>(query)
const resultData = result.campaigns
import type { EmailCampaigns, QueryEmailCampaigns } from 'netzo/apis/brevo/types.ts'

const query: QueryEmailCampaigns = {}
const result = await api.emailCampaigns.get<EmailCampaigns>(query)
const resultData = result.campaigns

Find companies ​

Find all companies with optional filtering and pagination.

ts
import type { Companies, QueryCompanies } from 'netzo/apis/brevo/types.ts'

const query: QueryCompanies = {}
const result = await api.companies.get<Companies>(query)
const resultData = result.items
import type { Companies, QueryCompanies } from 'netzo/apis/brevo/types.ts'

const query: QueryCompanies = {}
const result = await api.companies.get<Companies>(query)
const resultData = result.items

References ​

Copyright © 2023 Netzo