---
title: "SMS Marketing"
description: "API SMS Marketing - Envio de Campanhas por SMS"
lang: en
canonical: https://doc.apibrasil.io/apis/creditos/fd2508a3-bc08-12ef-becf-000c29865f18
markdown: https://doc.apibrasil.io/apis/creditos/fd2508a3-bc08-12ef-becf-000c29865f18.md
source: apibrasil-documentation
---

# SMS Marketing

> API SMS Marketing - Envio de Campanhas por SMS

- **Category:** Messaging
- **Billing:** per query, with the Bearer Token only
- **Price:** R$0.08 per query
- **Limit:** 990,000 per month
- **Registration:** CPF or CNPJ
- **Version:** v2
- **Published by:** APIBrasil
- **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/fd2508a3-bc08-12ef-becf-000c29865f18/openapi.json

## How to call

**Base address:** `https://gateway.apibrasil.io/api/v2`

Authentication: the `Authorization: Bearer <token>` header. Nothing else.

## Endpoints (1 endpoint)

### 1. POST /sms/send/credits

API SMS Marketing - Envio rápido de campanhas por SMS

Com a API SMS Marketing, sua empresa integra em poucos minutos o envio de mensagens promocionais pelo método POST, potencializando campanhas de SMS Marketing diretamente do seu sistema. Ganhe agilidade e alcance imediato no contato com seus clientes, ampliando o engajamento e fortalecendo ações comerciais. O endpoint retorna o status do envio, facilitando o controle e a análise dos resultados. Tudo isso com máxima segurança, escalabilidade e flexibilidade, permitindo adaptar o envio de SMS às necessidades específicas do seu negócio.

- **Method:** `POST`
- **Address:** `https://gateway.apibrasil.io/api/v2/sms/send/credits`
- **Route version:** v2

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Request body**

```json
{
  "tipo": "sms-marketing",
  "number": "5531994359434",
  "message": "Mensagem de marketing",
  "operator": "claro",
  "user_reply": true,
  "webhook_url": "https://webhook.site/b2fdae94-87b9-47b6-9276-52fbc0f8e16c"
}
```

**In cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/sms/send/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"sms-marketing","number":"5531994359434","message":"Mensagem de marketing","operator":"claro","user_reply":true,"webhook_url":"https://webhook.site/b2fdae94-87b9-47b6-9276-52fbc0f8e16c"}'
```

**Sample response, from the catalog**

```json
{
  "user": {
    "first_name": "[omitido]",
    "email": "[omitido]",
    "cellphone": "[omitido]",
    "notification": "yes"
  },
  "balance": "250,700",
  "balance_before": "250,780",
  "tax": "0,080",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 0,08.",
  "valor_consulta": 0.08,
  "api_limit_for": "credit",
  "homolog": false,
  "response": {
    "data": {
      "created_at": "2026-04-16 12:03:03",
      "id": "118011503269e0cff74c375567372441",
      "status": "processed"
    },
    "message": "Message sent successfully",
    "status": "success"
  }
}
```

In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes.

## Pitfalls: what an integration gets wrong without warning

Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else:

1. **The error arrives in the BODY, with HTTP 200.**
   The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`.

2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.**
   Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them.

3. **Every call costs money.**
   Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling.

4. **HTTP 402 means insufficient balance, and retrying does not fix it.**
   It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx.

5. **`extra_charges` bills on top of the lookup price.**
   When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both.

## See also

- OpenAPI specification: https://doc.apibrasil.io/apis/creditos/fd2508a3-bc08-12ef-becf-000c29865f18/openapi.json
- API catalog: [API catalog](https://doc.apibrasil.io/apis.md)
- Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md)
- Documentation index: https://doc.apibrasil.io/llms.txt
- HTML version of this page: https://doc.apibrasil.io/apis/creditos/fd2508a3-bc08-12ef-becf-000c29865f18