API

Every brevo.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Account

get

account.get Get Brevo account details, plans, and relay settings Risk: read

await corsair.brevo.api.account.get({});

Input: empty object Output

Name	Type	Required	Description
`email`	`string`	Yes	—
`firstName`	`string`	No	—
`lastName`	`string`	No	—
`companyName`	`string`	No	—
`address`	`object`	No	—
`plan`	`object[]`	No	—
`relay`	`object`	No	—

address full type

{
  street?: string,
  city?: string,
  zipCode?: string,
  country?: string
}

plan full type

{
  type: string,
  credits: number,
  creditsType?: string,
  startDate?: string,
  endDate?: string
}[]

relay full type

{
  enabled: boolean,
  data?: {
    userName?: string,
    relay?: string,
    port?: number
  }
}

Contacts

create

contacts.create Create a new Brevo contact Risk: write

await corsair.brevo.api.contacts.create({});

Input

Name	Type	Required	Description
`email`	`string`	No	—
`ext_id`	`string`	No	—
`attributes`	`object`	No	—
`emailBlacklisted`	`boolean`	No	—
`smsBlacklisted`	`boolean`	No	—
`listIds`	`number[]`	No	—
`updateEnabled`	`boolean`	No	—
`smtpBlacklistSender`	`string[]`	No	—

attributes full type

{
}

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

delete

contacts.delete Delete a Brevo contact [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.brevo.api.contacts.delete({});

Input

Name	Type	Required	Description
`identifier`	`string \| number`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

get

contacts.get Get a Brevo contact by ID or email identifier Risk: read

await corsair.brevo.api.contacts.get({});

Input

Name	Type	Required	Description
`identifier`	`string \| number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`email`	`string`	No	—
`emailBlacklisted`	`boolean`	No	—
`smsBlacklisted`	`boolean`	No	—
`createdAt`	`string`	No	—
`modifiedAt`	`string`	No	—
`listIds`	`number[]`	No	—
`listUnsubscribed`	`number[]`	No	—
`attributes`	`object`	No	—

attributes full type

{
}

list

contacts.list List Brevo contacts with filtering and pagination Risk: read

await corsair.brevo.api.contacts.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`modifiedSince`	`string`	No	—
`sort`	`asc \| desc`	No	—
`segmentId`	`number`	No	—
`listId`	`number`	No	—

Output

Name	Type	Required	Description
`contacts`	`object[]`	Yes	—
`count`	`number`	Yes	—

contacts full type

{
  id: number,
  email?: string | null,
  emailBlacklisted?: boolean,
  smsBlacklisted?: boolean,
  createdAt?: string,
  modifiedAt?: string,
  listIds?: number[],
  listUnsubscribed?: number[],
  attributes?: {
  }
}[]

update

contacts.update Update an existing Brevo contact by ID or email identifier Risk: write

await corsair.brevo.api.contacts.update({});

Input

Name	Type	Required	Description
`identifier`	`string \| number`	Yes	—
`attributes`	`object`	No	—
`emailBlacklisted`	`boolean`	No	—
`smsBlacklisted`	`boolean`	No	—
`listIds`	`number[]`	No	—
`unlinkListIds`	`number[]`	No	—
`smtpBlacklistSender`	`string[]`	No	—

attributes full type

{
}

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

Email Campaigns

create

emailCampaigns.create Create a new Brevo email campaign Risk: write

await corsair.brevo.api.emailCampaigns.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`subject`	`string`	Yes	—
`sender`	`object`	Yes	—
`htmlContent`	`string`	No	—
`htmlUrl`	`string`	No	—
`templateId`	`number`	No	—
`scheduledAt`	`string`	No	—
`recipients`	`object`	No	—
`replyTo`	`string`	No	—
`toField`	`string`	No	—
`tag`	`string`	No	—
`header`	`string`	No	—
`footer`	`string`	No	—
`utmCampaign`	`string`	No	—
`params`	`object`	No	—

sender full type

{
  name?: string,
  email?: string,
  id?: number
}

recipients full type

{
  lists?: number[],
  exclusionLists?: number[]
}

params full type

{
}

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

delete

emailCampaigns.delete Delete a Brevo email campaign [DESTRUCTIVE · IRREVERSIBLE] Risk: destructive · Irreversible

await corsair.brevo.api.emailCampaigns.delete({});

Input

Name	Type	Required	Description
`campaignId`	`number`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

get

emailCampaigns.get Get a Brevo email campaign by campaign ID Risk: read

await corsair.brevo.api.emailCampaigns.get({});

Input

Name	Type	Required	Description
`campaignId`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`subject`	`string`	No	—
`type`	`string`	No	—
`status`	`string`	No	—
`htmlContent`	`string`	No	—
`scheduledAt`	`string`	No	—
`sentDate`	`string`	No	—
`createdAt`	`string`	No	—
`modifiedAt`	`string`	No	—
`sender`	`object`	No	—
`replyTo`	`string`	No	—
`toField`	`string`	No	—
`htmlUrl`	`string`	No	—
`tag`	`string`	No	—
`recipients`	`object`	No	—
`statistics`	`object`	No	—

sender full type

{
  name?: string,
  email?: string,
  id?: number
}

recipients full type

{
  lists?: number[],
  exclusionLists?: number[]
}

statistics full type

{
}

list

emailCampaigns.list List Brevo email campaigns with filtering and pagination Risk: read

await corsair.brevo.api.emailCampaigns.list({});

Input

Name	Type	Required	Description
`type`	`classic \| trigger`	No	—
`status`	`suspended \| archive \| sent \| queued \| draft \| in_process`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`sort`	`asc \| desc`	No	—

Output

Name	Type	Required	Description
`campaigns`	`object[]`	Yes	—
`count`	`number`	Yes	—

campaigns full type

{
  id: number,
  name: string,
  subject?: string,
  type?: string,
  status?: string,
  scheduledAt?: string,
  sentDate?: string,
  createdAt?: string,
  modifiedAt?: string,
  recipients?: {
    lists?: number[],
    exclusionLists?: number[]
  }
}[]

sendNow

emailCampaigns.sendNow Send a Brevo email campaign immediately Risk: destructive · Irreversible

await corsair.brevo.api.emailCampaigns.sendNow({});

Input

Name	Type	Required	Description
`campaignId`	`number`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

sendTest

emailCampaigns.sendTest Send a test email for a Brevo email campaign Risk: write

await corsair.brevo.api.emailCampaigns.sendTest({});

Input

Name	Type	Required	Description
`campaignId`	`number`	Yes	—
`emailTo`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

update

emailCampaigns.update Update an existing Brevo email campaign Risk: write

await corsair.brevo.api.emailCampaigns.update({});

Input

Name	Type	Required	Description
`campaignId`	`number`	Yes	—
`name`	`string`	No	—
`subject`	`string`	No	—
`sender`	`object`	No	—
`htmlContent`	`string`	No	—
`htmlUrl`	`string`	No	—
`templateId`	`number`	No	—
`scheduledAt`	`string`	No	—
`recipients`	`object`	No	—
`replyTo`	`string`	No	—
`toField`	`string`	No	—
`tag`	`string`	No	—
`header`	`string`	No	—
`footer`	`string`	No	—
`utmCampaign`	`string`	No	—
`params`	`object`	No	—

sender full type

{
  name?: string,
  email?: string,
  id?: number
}

recipients full type

{
  lists?: number[],
  exclusionLists?: number[]
}

params full type

{
}

Output

Name	Type	Required	Description
`success`	`boolean`	No	—

Overview

Plugins

Account

get

Contacts

create

delete

get

list

update

Email Campaigns

create

delete

get

list

sendNow

sendTest

update

​Account

​get

​Contacts

​create

​delete

​get

​list

​update

​Email Campaigns

​create

​delete

​get

​list

​sendNow

​sendTest

​update

Account

get

Contacts

create

delete

get

list

update

Email Campaigns

create

delete

get

list

sendNow

sendTest

update