# SMS reporting settings

Source: https://neondeerdata.com/docs/api/brevo/reporting/

Read and change transactional SMS reporting settings.

The APIs on this page require alpha access for your organization. App availability and API access are separate. [Check access and permissions](https://neondeerdata.com/docs/api/permissions/).

## Get Brevo SMS reporting

```http
GET /v1/brevo-integration/sms-reporting

```

Gets whether transactional SMS is included in Brevo reports.

Requires `brevo:config:read`. The connection also needs access to the relevant tables, objects, or workflows.

MCP action: `get_brevo_sms_reporting`. 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_sms_reporting"` | Yes                |       |
| `data.transactional_sms` | boolean                 | Yes                |       |
| `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](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write.

## Change Brevo SMS reporting

```http
PUT /v1/brevo-integration/sms-reporting

```

Includes transactional SMS in Brevo reports or leaves it out, at the version the setting answered (expected_version).

Requires `brevo:config:write`. The connection also needs access to the relevant tables, objects, or workflows.

MCP action: `update_brevo_sms_reporting`. 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 |
| ------------------- | --------- | -------- | ---------------------- | ----- |
| `transactional_sms` | JSON body | Yes      | boolean                |       |
| `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_sms_reporting"` | Yes                |       |
| `data.transactional_sms` | boolean                 | Yes                |       |
| `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](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write.

The [public OpenAPI document](https://neondeerdata.com/docs/api/meta/openapi/) 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](https://neondeerdata.com/docs/api/testing/) to inspect a real response with your connection's access.
