Skip to main content
POST
/
campaigns
Enviar un template (campaña)
curl --request POST \
  --url https://api.automationhub.one/api:RIKjHOHm/campaigns \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "idempotency_key": "presupuesto-4812-followup-1",
  "template_name": "seguimiento_presupuesto",
  "template_language": "es_AR",
  "external_ref": "PRES-4812",
  "campaign_name": "Follow-up presupuesto 4812",
  "recipients": [
    {
      "phone": "+5491123456789",
      "params": [
        "Juan",
        "4812"
      ]
    }
  ]
}
'
{
  "campaign_id": "<string>",
  "status": "sent",
  "campaign_name": "<string>",
  "external_ref": "<string>",
  "recipients": {
    "added": 123,
    "duplicates": 123,
    "errors": [
      "<string>"
    ]
  },
  "replayed": true
}

Authorizations

X-API-Key
string
header
required

API key provista por Xenda (formato xnd_...). Se envía en todas las llamadas.

Body

application/json
idempotency_key
string
required

Clave única por envío. Reintentos con la misma clave no duplican el envío.

Maximum string length: 128
recipients
object[]
required
Required array length: 1 - 1000 elements
template_name
string

Nombre exacto del template aprobado. Requerido si no mandás template_id.

template_language
string

Código de idioma (ej. es_AR). Requerido solo si el template existe en más de un idioma.

template_id
string

ID del template (alternativa a template_name).

external_ref
string

Tu referencia (ej. ID de presupuesto). Se devuelve en la respuesta y en el webhook de respuestas.

campaign_name
string

Nombre visible de la campaña en la plataforma. Default: API - {template} - {external_ref}.

Response

Envío ejecutado (o replay idempotente de un envío previo).

campaign_id
string

ID del envío. Guardalo — viene en el webhook de respuestas.

status
enum<string>
Available options:
sent
campaign_name
string
external_ref
string | null
recipients
object
replayed
boolean

true si esta respuesta es el replay de un envío previo con la misma idempotency_key.