Skip to main content
POST
/
campaigns
/
import-messages
curl https://api.onepay.la/v1/campaigns/import-messages \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -H "x-idempotency: campaign-sensibilizacion-001" \
  -d '{
    "template": "sensibilizacion_primera_comunicacion",
    "image_url": "https://cdn.onepay.la/campaigns/sensibilizacion-abril.jpg",
    "phones": [
      "+573001234567",
      "+573009876543"
    ],
    "optional_1": "Texto adicional",
    "optional_2": null,
    "optional_3": null
  }'

{
  "message": "Messages imported successfully"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onepay.la/llms.txt

Use this file to discover all available pages before exploring further.

Feature flag requerido: La empresa debe tener habilitada la feature campaigns. Si no está habilitada, el endpoint responde 403 Forbidden con el mensaje “Company does not have this feature.”

​
Headers

​
x-idempotency
string
required
Token único para garantizar la idempotencia de la petición

​
Body

​
template
string
required
Nombre del template de WhatsApp. Valores permitidos: sensibilizacion_primera_comunicacion, sensibilizacion_primera_comunicacion_v2.
​
image_url
string
required
URL pública de la imagen para el header del template. Debe cumplir las siguientes restricciones:
  • Tamaño máximo: 2 MB (2,097,152 bytes)
  • Dimensiones exactas: 1280 x 960 píxeles
  • Formatos permitidos: image/jpeg, image/png
  • Timeout de descarga: 15 segundos
La imagen se descarga, valida y almacena en S3 antes de enviar los mensajes.
​
phones
string[]
required
Lista de números telefónicos en formato E.164 (ej: +573001234567). Mínimo 1 número. Máximo 20 caracteres por número.
​
optional_1
string
Parámetro opcional para el body del template. Si se usa el template sensibilizacion_primera_comunicacion, este campo debe contener el nombre de la compañía que envía la campaña.
​
optional_2
string
Parámetro opcional adicional para el body del template.
​
optional_3
string
Parámetro opcional adicional para el body del template.
curl https://api.onepay.la/v1/campaigns/import-messages \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -H "x-idempotency: campaign-sensibilizacion-001" \
  -d '{
    "template": "sensibilizacion_primera_comunicacion",
    "image_url": "https://cdn.onepay.la/campaigns/sensibilizacion-abril.jpg",
    "phones": [
      "+573001234567",
      "+573009876543"
    ],
    "optional_1": "Texto adicional",
    "optional_2": null,
    "optional_3": null
  }'

​
Response

​
message
string
Mensaje de confirmación indicando que la campaña fue enviada exitosamente.
{
  "message": "Messages imported successfully"
}