sendTransacSms

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/brevo/main/json-schema/brevo-send-transac-sms-schema.json",
  "title": "sendTransacSms",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/brevo-transactional-sms-api-openapi.yml#/components/schemas/sendTransacSms",
  "type": "object",
  "properties": {
    "organisationPrefix": {
      "type": "string",
      "description": "A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**"
    },
    "recipient": {
      "type": "string",
      "description": "Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'.\n"
    },
    "sender": {
      "type": "string",
      "description": "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters.** Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits.\n"
    },
    "tag": {
      "$ref": "#/$defs/SendTransacSmsTag",
      "description": "Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.\n"
    },
    "type": {
      "$ref": "#/$defs/SendTransacSmsType",
      "default": "transactional",
      "description": "Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc."
    },
    "unicodeEnabled": {
      "type": "boolean",
      "default": false,
      "description": "Format of the message. It indicates whether the content should be treated as unicode or not.\n"
    },
    "webUrl": {
      "type": "string",
      "format": "url",
      "description": "Webhook to call for each event triggered by the message (delivered etc.)"
    },
    "params": {
      "type": "object",
      "additionalProperties": {
        "description": "Any type"
      },
      "description": "Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used."
    },
    "templateId": {
      "type": "integer",
      "description": "Template ID to send SMS with the template. When provided, overrides the content parameter. Mandatory if 'content' is not passed."
    },
    "content": {
      "type": "string",
      "description": "Content of the message. If more than **160 characters** long, will be sent as multiple text messages. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed.\n"
    }
  },
  "required": [
    "recipient",
    "sender"
  ],
  "$defs": {
    "SendTransacSmsTag": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.\n",
      "title": "SendTransacSmsTag"
    },
    "SendTransacSmsType": {
      "type": "string",
      "enum": [
        "transactional",
        "marketing"
      ],
      "default": "transactional",
      "description": "Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.",
      "title": "SendTransacSmsType"
    }
  }
}