Campanhas

Estimar custo por quantidade

Changed on

Usa o preço de referência do mercado local. Para campanha com números de vários países, use o POST. templateName aceita nome ou ID. Permissão: READ.

get/v1/campaigns/estimate

Request

  • Base URL
    https://api.ararahq.com
  • Auth
    HTTP bearer

Query parameters

templateNamestring required

Nome ou ID do template.

countinteger required

Quantidade de destinatários, de 1 a 1.000.000.

Response

Estimativa

templateCategorystring required
recipientCountinteger required
templateCostnumber required

Custo Meta total, em reais.

araraFeenumber required

Taxa Arara total, em reais.

unitPricenumber required

Preço médio por mensagem.

totalCostnumber required

Total a debitar, em reais.

Example response

{
  "templateCategory": "MARKETING",
  "recipientCount": 2,
  "templateCost": 0.59,
  "araraFee": 0.177,
  "unitPrice": 0.3835,
  "totalCost": 0.767,
  "markets": [
    {
      "market": "BR",
      "count": 2,
      "unitPrice": 0.3835,
      "metaCostUnit": 0.295,
      "subtotal": 0.767
    }
  ]
}

Changes

    • info

      api tag Campanhas added

    • info

      api tag campaigns removed

    • info

      added the non-success response with the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property format changed from float to no format for status

    • breaking

      the response's property type changed from object to string for status

    • breaking

      the response's property format changed from float to no format for status

    • breaking

      the response's property format changed from float to no format for status

    • breaking

      the response's property format changed from float to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      for the query request parameter count, the max was set to 1000000.00

    • warning

      removed the optional property / from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the AUTHENTICATION enum value from the response property for the response status

    • info

      removed the MARKETING enum value from the response property for the response status

    • info

      removed the UTILITY enum value from the response property for the response status