Message activity settings and imports
Choose the message events copied into Attio and import or retry available history.
The APIs on this page require alpha access for your organization. App availability and API access are separate. Check access and permissions.
Get Brevo message Activity settings
GET /v1/brevo-integration/message-settings
Gets whether Brevo messages are added to Attio as Activities, which events (such as email.sent or email.opened), whether each email's subject and text are included, which events add a Person to Attio when no Person has the email address (add_people), whether it is working (when it needs attention, problem_message says what to fix and where), how many message Activities of the last 30 days are in each state, and the latest import of earlier Activities.
Requires brevo:config:read. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: get_brevo_message_settings. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
No request parameters are needed.
Response
| HTTP status | Result |
|---|---|
200 |
The requested result. Asynchronous work returns an operation to poll. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
object | Yes | |
data.object |
"brevo_message_settings" |
Yes | |
data.enabled |
boolean | Yes | |
data.events |
array of "email.sent", "email.delivered", "email.opened", "email.clicked", "email.bounced", "email.complaint", "email.unsubscribed", "email.blocked", "email.deferred", "email.invalid", "sms.sent", "sms.reply", "sms.delivered", "sms.bounced", "sms.unsubscribed", "sms.blocked", "sms.accepted", "sms.rejected", "sms.skipped", "whatsapp.sent", "whatsapp.reply", "whatsapp.delivered", "whatsapp.opened", "whatsapp.bounced", "whatsapp.unsubscribed", "whatsapp.error" |
Yes | |
data.include_subject |
boolean | Yes | |
data.add_people |
array of "email.opened", "email.clicked" |
Yes | |
data.status |
"off", "pending", "ready", "attention" |
Yes | |
data.problem |
"connection", "permissions", "provider", "schema", "capacity", "owned", "plan", "payment", "key", "people" or null |
Yes | |
data.problem_message |
string or null | Yes | |
data.waiting |
object | Yes | |
data.waiting.pending |
integer | Yes | |
data.waiting.delivered |
integer | Yes | |
data.waiting.unmatched |
integer | Yes | |
data.waiting.unconfirmed |
integer | Yes | |
data.waiting.failed |
integer | Yes | |
data.earlier_import |
object or null | Yes | |
data.earlier_import.from |
string | Yes | Alternative 1. |
data.earlier_import.to |
string | Yes | Alternative 1. |
data.earlier_import.complete |
boolean | Yes | Alternative 1. |
data.earlier_import.accepted |
integer | Yes | Alternative 1. |
data.earlier_import.problem |
boolean | Yes | Alternative 1. |
data.version |
string | Yes |
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, unknown_parameter. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
The current permissions, plan or policy do not allow this request. |
404 |
One of: not_found. |
409 |
The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. |
410 |
The requested resource or retained recovery data has expired. |
412 |
One of: version_conflict. |
413 |
One of: request_too_large. |
422 |
A field, filter or selection cannot be used for this request. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
Change Brevo message Activity settings
PUT /v1/brevo-integration/message-settings
Turns message Activities on or off, and chooses the events and whether each email's subject and text are included, at the version the settings answered (expected_version). Turning them on needs at least one event. Events other than email.sent need a plan that includes engagement Activities. add_people (email.opened, email.clicked; each must also be in events) adds one Person to Attio, with the email address and the first and last name Brevo has, when one of those events arrives for an address no Person has; it needs workspace access that can create People. Left out, it stays as it was.
Requires brevo:config:write. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: update_brevo_message_settings. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
Parameters
| Name | Send in | Required | Type or allowed values | Notes |
|---|---|---|---|---|
enabled |
JSON body | Yes | boolean | |
events |
JSON body | Yes | array of "email.sent", "email.delivered", "email.opened", "email.clicked", "email.bounced", "email.complaint", "email.unsubscribed", "email.blocked", "email.deferred", "email.invalid", "sms.sent", "sms.reply", "sms.delivered", "sms.bounced", "sms.unsubscribed", "sms.blocked", "sms.accepted", "sms.rejected", "sms.skipped", "whatsapp.sent", "whatsapp.reply", "whatsapp.delivered", "whatsapp.opened", "whatsapp.bounced", "whatsapp.unsubscribed", "whatsapp.error" |
|
include_subject |
JSON body | Yes | boolean | |
add_people |
JSON body | No | array of "email.opened", "email.clicked" |
|
expected_version |
JSON body | Yes | string |
Response
| HTTP status | Result |
|---|---|
200 |
The requested result. Asynchronous work returns an operation to poll. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
object | Yes | |
data.object |
"brevo_message_settings" |
Yes | |
data.enabled |
boolean | Yes | |
data.events |
array of "email.sent", "email.delivered", "email.opened", "email.clicked", "email.bounced", "email.complaint", "email.unsubscribed", "email.blocked", "email.deferred", "email.invalid", "sms.sent", "sms.reply", "sms.delivered", "sms.bounced", "sms.unsubscribed", "sms.blocked", "sms.accepted", "sms.rejected", "sms.skipped", "whatsapp.sent", "whatsapp.reply", "whatsapp.delivered", "whatsapp.opened", "whatsapp.bounced", "whatsapp.unsubscribed", "whatsapp.error" |
Yes | |
data.include_subject |
boolean | Yes | |
data.add_people |
array of "email.opened", "email.clicked" |
Yes | |
data.status |
"off", "pending", "ready", "attention" |
Yes | |
data.problem |
"connection", "permissions", "provider", "schema", "capacity", "owned", "plan", "payment", "key", "people" or null |
Yes | |
data.problem_message |
string or null | Yes | |
data.waiting |
object | Yes | |
data.waiting.pending |
integer | Yes | |
data.waiting.delivered |
integer | Yes | |
data.waiting.unmatched |
integer | Yes | |
data.waiting.unconfirmed |
integer | Yes | |
data.waiting.failed |
integer | Yes | |
data.earlier_import |
object or null | Yes | |
data.earlier_import.from |
string | Yes | Alternative 1. |
data.earlier_import.to |
string | Yes | Alternative 1. |
data.earlier_import.complete |
boolean | Yes | Alternative 1. |
data.earlier_import.accepted |
integer | Yes | Alternative 1. |
data.earlier_import.problem |
boolean | Yes | Alternative 1. |
data.version |
string | Yes |
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, unknown_parameter. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
The current permissions, plan or policy do not allow this request. |
404 |
One of: not_found. |
409 |
The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. |
410 |
The requested resource or retained recovery data has expired. |
412 |
One of: version_conflict. |
413 |
One of: request_too_large. |
422 |
A field, filter or selection cannot be used for this request. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
Import earlier Brevo messages
POST /v1/brevo-integration/message-settings/import
Starts adding earlier Brevo messages to Attio as Activities, for the events the message settings choose, from one date to another (to is today or earlier). Send the message settings' version as expected_version. It needs a plan that includes importing earlier Activities. Follow it with get_brevo_message_settings.
Requires brevo:execute. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: start_brevo_activity_import. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
Parameters
| Name | Send in | Required | Type or allowed values | Notes |
|---|---|---|---|---|
from |
JSON body | Yes | string (date) | |
to |
JSON body | Yes | string (date) | |
expected_version |
JSON body | Yes | string | |
request_key |
Header: Idempotency-Key |
Yes | string |
Response
| HTTP status | Result |
|---|---|
202 |
The requested result. Asynchronous work returns an operation to poll. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
object | Yes | |
data.object |
"brevo_activity_import" |
Yes | |
data.from |
string | Yes | |
data.to |
string | Yes | |
data.accepted |
true |
Yes |
Accepted work can continue after the request returns. Follow its returned status or operation until it finishes; accepting work does not mean every item succeeded. See operation status.
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, unknown_parameter, invalid_request. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
The current permissions, plan or policy do not allow this request. |
404 |
One of: not_found. |
409 |
The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. |
410 |
The requested resource or retained recovery data has expired. |
412 |
One of: version_conflict. |
413 |
One of: request_too_large. |
422 |
A field, filter or selection cannot be used for this request. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
Retry waiting Brevo messages and contact updates
POST /v1/brevo-integration/message-settings/retry
Retries eligible failed, unmatched, or unconfirmed message Activities and each Person’s latest unsynced contact update. count reports message Activities; contact_updates reports queued, remaining, waiting, and from_attio counts. Call again when more remain. List additions and contact-creating actions must be repeated from Attio. This does not resend outgoing template emails. Follow Activity for each result.
Requires brevo:execute. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: retry_brevo_activities. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
Parameters
| Name | Send in | Required | Type or allowed values | Notes |
|---|---|---|---|---|
request_key |
Header: Idempotency-Key |
Yes | string |
Response
| HTTP status | Result |
|---|---|
202 |
The requested result. Asynchronous work returns an operation to poll. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
object | Yes | |
data.object |
"brevo_activity_retry" |
Yes | |
data.count |
integer | Yes | |
data.contact_updates |
object | Yes | |
data.contact_updates.queued |
integer | Yes | |
data.contact_updates.remaining |
integer | Yes | |
data.contact_updates.waiting |
integer | Yes | |
data.contact_updates.from_attio |
integer | Yes |
Accepted work can continue after the request returns. Follow its returned status or operation until it finishes; accepting work does not mean every item succeeded. See operation status.
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, unknown_parameter, invalid_request. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
The current permissions, plan or policy do not allow this request. |
404 |
One of: not_found. |
409 |
The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. |
410 |
The requested resource or retained recovery data has expired. |
412 |
One of: version_conflict. |
413 |
One of: request_too_large. |
422 |
A field, filter or selection cannot be used for this request. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
The public OpenAPI document lists generally available API families. Alpha operations may not appear in that document; their request and response fields are listed on this page. Use the API Playground to inspect a real response with your connection's access.